git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] Grammar and wording fixes in gitrepository-layout

From
Ben Walton <bwalton@artsci.utoronto.ca>
Date
Aug 23, 2011, 00:43 UTC
Message-ID
<1314057078-sup-8464@pinkfloyd.chass.utoronto.ca>
In-Reply-To
<7vk4a5wc67.fsf@alter.siamese.dyndns.org>
Excerpts from Junio C Hamano's message of Mon Aug 22 14:09:36 -0400 2011:
Hi Junio,
> Perhaps we should deprecate http-fetch without -a and drop this item
> from the list?

I don't know much about http-fetch as I've never touched it directly. It doesn't sound like a good idea to allow creating a broken object store though. I'll send a patch shortly that adds the deprecation warning if -a isn't given.

Show 13 quoted lines
> > +. You could be using the `objects/info/alternates` or
> > +`$GIT_ALTERNATE_OBJECT_DIRECTORIES` mechanisms to 'borrow'
> >  objects from other object stores.  A repository with this kind
> >  of incomplete object store is not suitable to be published for
> > -use with dumb transports but otherwise is OK as long as
> > -`objects/info/alternates` points at the right object stores
> > -it borrows from.
> > +use with dumb transports but is otherwise OK as long as
> > +`objects/info/alternates` points at the right object stores.
> 
> The last three words in the original are meant to clarify and define
> what "the right object stores" are. Was there a compelling reason to
> drop them?

The only reason I dropped them is that I didn't feel they were helping to clarify the meaning. The wording was a bit awkward and I thought 'it borrows from' was part the problem. I see what you're saying though and think that the following wording is better:

use with dumb transports but is otherwise OK as long as `objects/info/alternates` points to object stores containing the missing objects.

Show 6 quoted lines
> >  objects/[0-9a-f][0-9a-f]::
> >      Traditionally, each object is stored in its own file.
> 
> I would suggest further rewording this to something like:
> 
>     A newly created object is stored in its own file.
Agreed.  This is much better.
Show 15 quoted lines
> > @@ -120,15 +118,15 @@ HEAD::
> >  HEAD can also record a specific commit directly, instead of
> >  being a symref to point at the current branch.  Such a state
> >  is often called 'detached HEAD', and almost all commands work
> > -identically as normal.  See linkgit:git-checkout[1] for
> > +as they normally would.  See linkgit:git-checkout[1] for
> >  details.
> 
> We may want to reword the sentence that begins with "almost all commands"
> further. In the early days after detached HEAD support was introduced, we
> may have left cases where the result was _undefined_ for commands that
> would not make sense unless you are on a branch, but by now what we have
> should behave sensibly by either erroring out when the operation does not
> make sense unless you are on a real branch, or doing something
> useful.

Ok, how about a full stop after 'detached HEAD' and then the link to git-checkout?

Show 18 quoted lines
> >  branches::
> >      A slightly deprecated way to store shorthands to be used
> > -    to specify URL to 'git fetch', 'git pull' and 'git push'
> > -    commands is to store a file in `branches/<name>` and
> > -    give 'name' to these commands in place of 'repository'
> > -    argument.
> > +    to specify a URL to 'git fetch', 'git pull' and 'git push'.
> > +    A file can be stored as `branches/<name>` and then
> > +    'name' can be givent to these commands in place of
> 
> s/givent to/given to/
> 
> > +    'repository' argument.
> 
> We would at least need "See linkgit:..." to say what is expected in this
> file and how it is used (the information is in urls-remotes.txt but that
> is not a top-level file, so it needs to refer to git-fetch and git-push
> instead).
Noted.  The updated patch will address this.
Show 16 quoted lines
> > @@ -173,9 +171,9 @@ info/exclude::
> >      at it.  See also: linkgit:gitignore[5].
> >  
> >  remotes::
> > -    Stores shorthands to be used to give URL and default
> > -    refnames to interact with remote repository to
> > -    'git fetch', 'git pull' and 'git push' commands.
> > +    Stores shorthands for URL and default refnames for use
> > +    when interacting with remote repositories via 'git fetch',
> > +    'git pull' and 'git push' commands.
> 
> Likewise.
> 
> Also I would personally consider "branches" and "remotes" both "slightly
> deprecated". "git init", "git clone", and "git remote" stopped populating
> these long time ago.

Ok, I've added the note about this being legacy to both of the sections in question.

Updated patch to follow shortly.

Thanks -Ben -- Ben Walton Systems Programmer - CHASS University of Toronto C:416.407.5610 | W:416.978.4302

Previous: Junio C HamanoNext: Ben Walton
Message 3 of 9 in “Grammar and wording fixes in gitrepository-layout”
  1. Grammar and wording fixes in gitrepository-layoutBen Walton, Aug 20, 2011
  2. Junio C HamanoAug 22, 2011
  3. Ben WaltonAug 23, 2011
  4. Documentation: Grammar correction, wording fixes and cleanupBen Walton, Aug 23, 2011
  5. Drew NorthupAug 23, 2011
  6. Junio C HamanoAug 23, 2011
  7. Documentation: Grammar correction, wording fixes and cleanupBen Walton, Aug 24, 2011
  8. Drew NorthupAug 24, 2011
  9. Ben WaltonAug 24, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.