From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: Johan Herland <johan@herland.net>,
Thomas Rast <trast@student.ethz.ch>, Jeff King <peff@peff.net>
Subject: [PATCH v2 0/8] filling out the notes man page
Date: Sat, 8 May 2010 22:13:57 -0500 [thread overview]
Message-ID: <20100509031357.GA7926@progeny.tock> (raw)
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
next reply other threads:[~2010-05-09 3:13 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-05-09 3:13 Jonathan Nieder [this message]
2010-05-09 3:19 ` [PATCH 1/8] Documentation/notes: document format of notes trees Jonathan Nieder
2010-05-09 6:52 ` Jeff King
2010-05-09 3:21 ` [PATCH 2/8] Documentation/notes: describe content of notes blobs Jonathan Nieder
2010-05-09 3:21 ` [PATCH 3/8] Documentation/notes: add configuration section Jonathan Nieder
2010-05-09 3:23 ` [PATCH 4/8] Documentation/notes: simplify treatment of default notes ref Jonathan Nieder
2010-05-12 7:46 ` Thomas Rast
2010-05-12 10:28 ` Jonathan Nieder
2010-05-09 3:30 ` [PATCH 5/8] Documentation/log: add a CONFIGURATION section Jonathan Nieder
2010-05-09 6:57 ` Jeff King
2010-05-09 3:32 ` [PATCH 6/8] Documentation/notes: simplify treatment of default display refs Jonathan Nieder
2010-05-09 7:00 ` Jeff King
2010-05-09 8:43 ` Jonathan Nieder
2010-05-10 6:06 ` Jeff King
2010-05-12 10:50 ` Jonathan Nieder
2010-05-12 11:23 ` Jeff King
2010-05-09 3:33 ` [PATCH 7/8] Documentation/notes: clean up description of rewriting configuration Jonathan Nieder
2010-05-09 3:37 ` [PATCH 8/8] Documentation/notes: nitpicks Jonathan Nieder
2010-05-10 23:27 ` [PATCH v2 0/8] filling out the notes man page Johan Herland
2010-05-12 7:48 ` Thomas Rast
2010-05-12 12:57 ` [PATCH v3] Documentation/notes: fill out the man page a little Jonathan Nieder
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100509031357.GA7926@progeny.tock \
--to=jrnieder@gmail.com \
--cc=git@vger.kernel.org \
--cc=johan@herland.net \
--cc=peff@peff.net \
--cc=trast@student.ethz.ch \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.