On Mon, Sep 10, 2007 at 01:54:29PM -0700, Joel Becker wrote:
> The suggestions are pretty simple. First, when behavior is
> changed invisibly (as the remote branch stuff was), can we note it in
> the documentation? I don't mean the ChangeLog, I mean the manpage. I
Here's the sort of thing I mean. It's small. It's near the
bottom, past anything interesting to a user who is just checking current
usage. It doesn't go into detail; that's what the release notes are
for.
But my coworker, who thought he'd broken something when the
branches were missing, would have seen "remote branches have their own
namespace". He would understood that he hadn't broken something, and he
would then follow the pointer to the release notes.
I'd have a simple rule for this section: behavior changes that
don't affect the previous version are dropped. That is, a behavior
change from 1.2 -> 1.3 is uninteresting, because the previous version is
already 1.4. A change from 1.3 -> 1.4 is interesting, because it
affects the previous version. So this would allow us to expire records
in the section.
Joel
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 253f4f0..478f885 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -178,6 +178,16 @@ $ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
------------
+Behavior Changes
+----------------
+See release notes.
+
+1.4 -> 1.5::
+ - Remote branches have their own namespace.
+ - Origin configuration is stored in $GIT_DIR/config.
+ - 1.5 client+server will negotiate a pack format unreadable by older clients.
+
+
Author
------
Written by Linus Torvalds <torvalds@xxxxxxxx>
--
"Not being known doesn't stop the truth from being true."
- Richard Bach
Joel Becker
Principal Software Developer
Oracle
E-mail: joel.becker@xxxxxxxxxx
Phone: (650) 506-8127
-
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
