git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "J. Bruce Fields" <bfields@fieldses.org>
To: Jakub Narebski <jnareb@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation: A few minor fixes to Git User's Manual
Date: Tue, 3 Apr 2007 13:21:13 -0400	[thread overview]
Message-ID: <20070403172113.GB26201@fieldses.org> (raw)
In-Reply-To: <11756176481314-git-send-email-jnareb@gmail.com>

On Tue, Apr 03, 2007 at 06:27:28PM +0200, Jakub Narebski wrote:
> Mainly consistent usage of "git command" and not "git-command" syntax

Looks good, thanks!

> A few [shorthand] comments about Git User's Manual:

And thanks very much for the comments.

> * inconsistent use of header levels
>         Level 0 (top level):     ======================
>         Level 1:                 ----------------------
>         Level 2:                 ~~~~~~~~~~~~~~~~~~~~~~
>         Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^
>         Level 4 (bottom level):  ++++++++++++++++++++++

Have you found internal inconsistencies, or are you just referring to
the fact that it's using different syntax from the default?

My original intention was to suck in other articles under Documentation/
as chapters.  Shifting all the headers by one allows us to do that, at
least initially, by just including the articles without modification.
The glossary is the only thing we're currently using that way, though.

The "Git interals" chapter is obviously most taken from the README,
which has gotten out of date in a few places.

My vague medium-term plan is to revise that chapter and then merge
tutorial-2.txt into it, and maybe core-tutorial too, but I haven't had
time to work on it recently.  (Any help appreciated.)

I'd kinda like to remove all the tutorials some day and absorb them into
the manual instead, but maybe that would be unpopular.

--b.

  reply	other threads:[~2007-04-03 17:21 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-04-03 16:27 [PATCH] Documentation: A few minor fixes to Git User's Manual Jakub Narebski
2007-04-03 17:21 ` J. Bruce Fields [this message]
2007-04-04 15:22   ` Jakub Narebski
2007-04-03 18:39 ` Junio C Hamano
2007-04-03 18:57   ` J. Bruce Fields
2007-04-03 19:03 ` Junio C Hamano
2007-04-04 18:31   ` Jakub Narebski

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=20070403172113.GB26201@fieldses.org \
    --to=bfields@fieldses.org \
    --cc=git@vger.kernel.org \
    --cc=jnareb@gmail.com \
    /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).