All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Thomas Ackermann <th.acker@arcor.de>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 0/3] Some small fixes to glossary-content.txt
Date: Tue, 02 Apr 2013 08:48:30 -0700	[thread overview]
Message-ID: <7vbo9xgchd.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <1481339149.727628.1364894663266.JavaMail.ngmail@webmail14.arcor-online.net> (Thomas Ackermann's message of "Tue, 2 Apr 2013 11:24:23 +0200 (CEST)")

Thomas Ackermann <th.acker@arcor.de> writes:

> While proof-reading the user-manual I noticed some issues with glossary-content.txt:
>
> - There is some outdated, misleading or irrelevant information which might only confuse
> new Git users and should therefore be removed.
> - The entries for object, object name and SHA1 lacked a little bit of consistency.
> - The glossary contains partial definitions for refspec and pathspec.

Only on the "partial" bit, and not limited to refspec and pathspec.

I think ideally for any key concepts:

 - The glossary should mention what it is and what it is used for;

 - Individual manual pages should mention how it is constructed and
   how it can be used.  To be complete, it may need to start by
   describing what it is and what it is used for, which may have to
   duplicate what we say in the glossary.

  parent reply	other threads:[~2013-04-02 15:49 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-02  9:24 [PATCH 0/3] Some small fixes to glossary-content.txt Thomas Ackermann
2013-04-02  9:26 ` [PATCH 1/3] Remove outdated/missleading/irrelevant entries from glossary-content.txt Thomas Ackermann
2013-04-02 15:56   ` Junio C Hamano
2013-04-02  9:27 ` [PATCH 2/3] Improve description of SHA1 related topics in glossary-content.txt Thomas Ackermann
2013-04-02 16:05   ` Junio C Hamano
2013-04-02  9:28 ` [PATCH 3/3] Remove definition of refspec and pathspec from glossary-content.txt Thomas Ackermann
2013-04-02 16:08   ` Junio C Hamano
2013-04-02 17:05   ` Aw: " Thomas Ackermann
2013-04-02 17:23     ` Junio C Hamano
2013-04-02 17:34     ` Aw: " Thomas Ackermann
2013-04-02 15:48 ` Junio C Hamano [this message]
2013-04-06  8:00 ` Aw: Re: [PATCH 0/3] Some small fixes to glossary-content.txt Thomas Ackermann

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=7vbo9xgchd.fsf@alter.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=th.acker@arcor.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.