[PATCH v2 0/8] filling out the notes man page

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

Many thanks for the feedback from last round[1].  I tried to take your
comments to heart and carry them out as well as I could.  I hope you
like the result.  Doubtless some of the new text I added is unclear,
so as usual, your comments are welcome.

The first two patches sum up the low-level basics that a reader should
know.  For the format of trees, I renamed the NOTES section to
DISCUSSION and added a paragraph or two (and a footnote, triggering a
bug in docbook-xsl; more on that later); for the format of notes
blobs, I added an example to illustrate Johan’s trick for arbitrary
binary notes.  Thanks for the tip.

The next five patches aim to make the treatment of configuration a
little more systematic.  git-notes.1 gains Configuration and
Environment sections and git-log.1 gains a Configuration section (but
not Environment, because I am lazy).

Of course, there is a lot still to document.  It is not obvious to me
yet what relationship notes will have to other commands, such as
format-patch.

Thanks,
Jonathan Nieder (8):
  Documentation/notes: document format of notes trees
  Documentation/notes: describe content of notes blobs
  Documentation/notes: add configuration section
  Documentation/notes: simplify treatment of default notes ref
  Documentation/log: add a CONFIGURATION section
  Documentation/notes: simplify treatment of default display refs
  Documentation/notes: clean up description of rewriting configuration
  Documentation/notes: nitpicks

 Documentation/config.txt    |   16 +---
 Documentation/git-log.txt   |   42 ++++++++++
 Documentation/git-notes.txt |  177 +++++++++++++++++++++++++++++++++++++------
 t/t3307-notes-man.sh        |   38 +++++++++
 4 files changed, 238 insertions(+), 35 deletions(-)
 create mode 100755 t/t3307-notes-man.sh

[1] http://thread.gmane.org/gmane.comp.version-control.git/146269
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]