1. 04 Aug, 2011 1 commit
    • Jeff King's avatar
      docs: put listed example commands in backticks · 5d2fc913
      Jeff King authored
      Many examples of git command invocation are given in asciidoc listing
      blocks, which makes them monospaced and avoids further interpretation of
      special characters.  Some manpages make a list of examples, like:
      
        git foo::
          Run git foo.
      
        git foo -q::
          Use the "-q" option.
      
      to quickly show many variants. However, they can sometimes be hard to
      read, because they are shown in a proportional-width font (so, for
      example, seeing the difference between "-- foo" and "--foo" can be
      difficult).
      
      This patch puts all such examples into backticks, which gives the
      equivalent formatting to a listing block (i.e., monospaced and without
      character interpretation).
      
      As a bonus, this also fixes an example in the git-push manpage, in which
      "git push origin :::" was accidentally considered a newly-indented list,
      and not a list item with "git push origin :" in it.
      Signed-off-by: default avatarJeff King <peff@peff.net>
      Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
      5d2fc913
  2. 11 Mar, 2011 1 commit
    • Jeff King's avatar
      doc: drop author/documentation sections from most pages · 48bb914e
      Jeff King authored
      The point of these sections is generally to:
      
        1. Give credit where it is due.
      
        2. Give the reader an idea of where to ask questions or
           file bug reports.
      
      But they don't do a good job of either case. For (1), they
      are out of date and incomplete. A much more accurate answer
      can be gotten through shortlog or blame.  For (2), the
      correct contact point is generally git@vger, and even if you
      wanted to cc the contact point, the out-of-date and
      incomplete fields mean you're likely sending to somebody
      useless.
      
      So let's drop the fields entirely from all manpages except
      git(1) itself. We already point people to the mailing list
      for bug reports there, and we can update the Authors section
      to give credit to the major contributors and point to
      shortlog and blame for more information.
      
      Each page has a "This is part of git" footer, so people can
      follow that to the main git manpage.
      48bb914e
  3. 03 Mar, 2010 2 commits
  4. 10 Jan, 2010 1 commit
    • Thomas Rast's avatar
      Documentation: spell 'git cmd' without dash throughout · 0b444cdb
      Thomas Rast authored
      The documentation was quite inconsistent when spelling 'git cmd' if it
      only refers to the program, not to some specific invocation syntax:
      both 'git-cmd' and 'git cmd' spellings exist.
      
      The current trend goes towards dashless forms, and there is precedent
      in 647ac702 (git-svn.txt: stop using dash-form of commands.,
      2009-07-07) to actively eliminate the dashed variants.
      
      Replace 'git-cmd' with 'git cmd' throughout, except where git-shell,
      git-cvsserver, git-upload-pack, git-receive-pack, and
      git-upload-archive are concerned, because those really live in the
      $PATH.
      0b444cdb
  5. 30 Nov, 2009 1 commit
    • Junio C Hamano's avatar
      git-merge-file --ours, --theirs · 73eb40ee
      Junio C Hamano authored
      Sometimes people want their conflicting merges autoresolved by
      favouring upstream changes.  The standard answer they are given is
      to run "git diff --name-only | xargs git checkout MERGE_HEAD --" in
      such a case.  This is to accept automerge results for the paths that
      are fully resolved automatically, while taking their version of the
      file in full for paths that have conflicts.
      
      This is problematic on two counts.
      
      One is that this is not exactly what these people want.  It discards
      all changes they did on their branch for any paths that conflicted.
      They usually want to salvage as much automerge result as possible in
      a conflicted file, and want to take the upstream change only in the
      conflicted part.
      
      This patch teaches two new modes of operation to the lowest-lever
      merge machinery, xdl_merge().  Instead of leaving the conflicted
      lines from both sides enclosed in <<<, ===, and >>> markers, the
      conflicts are resolved favouring our side or their side of changes.
      
      A larger problem is that this tends to encourage a bad workflow by
      allowing people to record such a mixed up half-merged result as a
      full commit without auditing.  This commit does not tackle this
      issue at all.  In git, we usually give long enough rope to users
      with strange wishes as long as the risky features are not enabled by
      default, and this is such a risky feature.
      Signed-off-by: default avatarAvery Pennarun <apenwarr@gmail.com>
      Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
      73eb40ee
  6. 10 Dec, 2008 1 commit
  7. 05 Jul, 2008 3 commits
  8. 02 Jul, 2008 2 commits
    • Jonathan Nieder's avatar
      Documentation formatting and cleanup · 483bc4f0
      Jonathan Nieder authored
      Following what appears to be the predominant style, format
      names of commands and commandlines both as `teletype text`.
      
      While we're at it, add articles ("a" and "the") in some
      places, italicize the name of the command in the manual page
      synopsis line, and add a comma or two where it seems appropriate.
      Signed-off-by: default avatarJonathan Nieder <jrnieder@uchicago.edu>
      Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
      483bc4f0
    • Jonathan Nieder's avatar
      Documentation: be consistent about "git-" versus "git " · b1889c36
      Jonathan Nieder authored
      Since the git-* commands are not installed in $(bindir), using
      "git-command <parameters>" in examples in the documentation is
      not a good idea. On the other hand, it is nice to be able to
      refer to each command using one hyphenated word. (There is no
      escaping it, anyway: man page names cannot have spaces in them.)
      
      This patch retains the dash in naming an operation, command,
      program, process, or action. Complete command lines that can
      be entered at a shell (i.e., without options omitted) are
      made to use the dashless form.
      
      The changes consist only of replacing some spaces with hyphens
      and vice versa. After a "s/ /-/g", the unpatched and patched
      versions are identical.
      Signed-off-by: default avatarJonathan Nieder <jrnieder@uchicago.edu>
      Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
      b1889c36
  9. 06 Jun, 2008 1 commit
  10. 07 Jan, 2008 1 commit
    • Dan McGee's avatar
      Documentation: rename gitlink macro to linkgit · 5162e697
      Dan McGee authored
      Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock
      Asciidoc configuration:
      
      @@ -149,7 +153,10 @@
       # Inline macros.
       # Backslash prefix required for escape processing.
       # (?s) re flag for line spanning.
      -(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])=
      +
      +# Explicit so they can be nested.
      +(?su)[\\]?(?P<name>(http|https|ftp|file|mailto|callto|image|link)):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])=
      +
       # Anchor: [[[id]]]. Bibliographic anchor.
       (?su)[\\]?\[\[\[(?P<attrlist>[\w][\w-]*?)\]\]\]=anchor3
       # Anchor: [[id,xreflabel]]
      
      This default regex now matches explicit values, and unfortunately in this
      case gitlink was being matched by just 'link', causing the wrong inline
      macro template to be applied. By renaming the macro, we can avoid being
      matched by the wrong regex.
      Signed-off-by: Dan McGee's avatarDan McGee <dpmcgee@gmail.com>
      Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
      5162e697
  11. 18 Jan, 2007 1 commit
  12. 17 Dec, 2006 1 commit
  13. 16 Dec, 2006 1 commit