threads / patch / 9873

patch, 12 partsRe: [PATCH 11/12] documentation: replace Discussion section by link to user-manual chapter

Subject: Re: [PATCH 11/12] documentation: replace Discussion section by link to user-manual chapter

## tl;dr

3 messages between Sep 16, 2007 and Sep 16, 2007. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

J. Bruce Fields· Sep 16, 2007, 01:56 UTC · lore
On Sun, Sep 09, 2007 at 11:01:57PM +0200, Andreas Ericsson wrote:
Show 8 quoted lines
> J. Bruce Fields wrote:
>> +
>> +A git project normally consists of a working directory with a ".git"
>> +subdirectory at the top level.  The .git directory contains, among other
>> +things, a compressed object database representing the complete history
>> +of the project, a set of pointers into that history ("refs")
>
> ... into that history ("refs" - branches and tags)
I slept on it and took another look, and decided you were right; this is
what I have there now:
 
  A git project normally consists of a working directory with a ".git"
  subdirectory at the top level.  The .git directory contains, among
  other things, a compressed object database representing the complete
  history of the project, an "index" file which links that history to
  the current contents of the working tree, and named pointers into that
  history such as tags and branch heads.
 
--b.
Andreas Ericsson· Sep 16, 2007, 19:38 UTC · re: J. Bruce Fields · lore
J. Bruce Fields wrote:
Show 19 quoted lines
> On Sun, Sep 09, 2007 at 11:01:57PM +0200, Andreas Ericsson wrote:
>> J. Bruce Fields wrote:
>>> +
>>> +A git project normally consists of a working directory with a ".git"
>>> +subdirectory at the top level.  The .git directory contains, among other
>>> +things, a compressed object database representing the complete history
>>> +of the project, a set of pointers into that history ("refs")
>> ... into that history ("refs" - branches and tags)
> 
> I slept on it and took another look, and decided you were right; this is
> what I have there now:
>  
>   A git project normally consists of a working directory with a ".git"
>   subdirectory at the top level.  The .git directory contains, among
>   other things, a compressed object database representing the complete
>   history of the project, an "index" file which links that history to
>   the current contents of the working tree, and named pointers into that
>   history such as tags and branch heads.
>  
Looks good. Thanks :)
-- 
Andreas Ericsson                   andreas.ericsson@op5.se
OP5 AB                             www.op5.se
Tel: +46 8-230225                  Fax: +46 8-230231
J. Bruce Fields· Sep 16, 2007, 02:20 UTC · lore

Re: [PATCH 05/12] user-manual: rewrite index discussion

On Sun, Sep 09, 2007 at 05:38:20PM -0700, Junio C Hamano wrote:
> At the end of first paragraph as a note would be good.  People
> may scan from top to bottom (maybe "Find...") to look for
> "cache" and find the sentence "this chapter is about index but
> that is what you are looking for".  That feels a natural flow.

OK, I've addressed all the comments I've gotten and pushed an updated version to:

  git://linux-nfs.org/~bfields/git.git maint
Please pull if it looks ready.
--b.
J. Bruce Fields (12):
      user-manual: adjust section levels in "git internals"
      user-manual: move object format details to hacking-git chapter
      user-manual: rename "git internals" to "git concepts"
      user-manual: create new "low-level git operations" chapter
      user-manual: rewrite index discussion
      user-manual: reorder commit, blob, tree discussion
      user-manual: rewrite object database discussion
      user-manual: move packfile and dangling object discussion
      user-manual: fix introduction to packfiles
      user-manual: todo updates and cleanup
      documentation: replace Discussion section by link to user-manual chapter
      core-tutorial: minor cleanup
 Documentation/Makefile          |    2 +-
 Documentation/core-intro.txt    |  592 --------------------------
 Documentation/core-tutorial.txt |   32 +-
 Documentation/git.txt           |   57 +++-
 Documentation/user-manual.txt   |  868 ++++++++++++++++++++++-----------------
 5 files changed, 548 insertions(+), 1003 deletions(-)
 delete mode 100644 Documentation/core-intro.txt

← back to recent threads