[v3,0/4] docs: add docs about use of automatic cleanup functions
mbox series

Message ID 20190829165036.9773-1-berrange@redhat.com
Headers show
Series
  • docs: add docs about use of automatic cleanup functions
Related show

Message

Daniel P. Berrangé Aug. 29, 2019, 4:50 p.m. UTC
This is ostensibly about adding docs for the g_autofree/g_autoptr
macros. As part of doing that, however, the existing HACKING doc
is merged into the CODING_STYLE doc and the text is converted to
rst with a table of contents.

Changed in v3:

 - Make checkpatch.pl aware of README.rst rename

Changed in v2:

 - Use RST instead of markdown
 - Also convert README file
 - Group sections better
 - Remove GMutexLocker example

Daniel P. Berrangé (4):
  docs: convert README, CODING_STYLE and HACKING to RST syntax
  docs: merge HACKING.rst contents into CODING_STYLE.rst
  docs: document use of automatic cleanup functions in glib
  docs: split the CODING_STYLE doc into distinct groups

 CODING_STYLE          | 216 --------------
 CODING_STYLE.rst      | 641 ++++++++++++++++++++++++++++++++++++++++++
 HACKING               | 257 -----------------
 README => README.rst  |  47 ++--
 scripts/checkpatch.pl |   2 +-
 5 files changed, 671 insertions(+), 492 deletions(-)
 delete mode 100644 CODING_STYLE
 create mode 100644 CODING_STYLE.rst
 delete mode 100644 HACKING
 rename README => README.rst (84%)