git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andrew Ruder <andy@aeruder.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <junkio@cox.net>, andy@aeruder.net
Subject: [PATCH] Add policy on user-interface changes
Date: Mon, 16 Apr 2007 00:35:25 -0500	[thread overview]
Message-ID: <20070416053525.GA18821@localdomain> (raw)

Documentation/SubmittingPatches: Add note that all user interface changes
should include associated documentation updates.

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/SubmittingPatches |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 131bcff..2386f49 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -22,6 +22,9 @@ Checklist (and a short version for the impatient):
 	- provide additional information (which is unsuitable for
 	  the commit message) between the "---" and the diffstat
 	- send the patch to the list _and_ the maintainer
+	- if you change, add, or remove a command line option or
+	  make some other user interface change, the associated
+	  documentation should be updated as well.
 
 Long version:
 
-- 
1.5.1.1.98.gedb4f-dirty

             reply	other threads:[~2007-04-16  6:08 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-04-16  5:35 Andrew Ruder [this message]
2007-04-16  6:20 ` [PATCH] Update git-am documentation Andrew Ruder
2007-04-16  6:56   ` Junio C Hamano
2007-04-16  7:21     ` Andrew Ruder
2007-04-16  7:48       ` Junio C Hamano
2007-04-16 12:47         ` Andrew Ruder
2007-04-16  6:20 ` [PATCH] Update git-applymbox documentation Andrew Ruder
2007-04-16  6:40   ` Andrew Ruder
2007-04-16  6:20 ` [PATCH] Update git-annotate/git-blame documentation Andrew Ruder
2007-04-16  7:24   ` Alex Riesen
2007-04-16  7:26     ` Andrew Ruder
2007-04-16  7:52       ` Junio C Hamano
2007-04-17  2:45         ` Andrew Ruder
2007-04-16  6:20 ` [PATCH] Update git-apply documentation Andrew Ruder
2007-04-19  3:03 ` [PATCH] Update git-archive documentation Andrew Ruder
2007-04-19  3:03 ` [PATCH] Update git-cherry-pick documentation Andrew Ruder
2007-04-19  3:03 ` [PATCH] Fix unmatched emphasis tag in git-tutorial Andrew Ruder
2007-04-19  3:03 ` [PATCH] Update git-config documentation Andrew Ruder

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=20070416053525.GA18821@localdomain \
    --to=andy@aeruder.net \
    --cc=git@vger.kernel.org \
    --cc=junkio@cox.net \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).