1. 01 Feb, 2013 1 commit
  2. 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
  3. 06 Jul, 2011 1 commit
    • Martin von Zweigbergk's avatar
      Documentation: use [verse] for SYNOPSIS sections · 7791a1d9
      Martin von Zweigbergk authored
      The SYNOPSIS sections of most commands that span several lines already
      use [verse] to retain line breaks. Most commands that don't span
      several lines seem not to use [verse]. In the HTML output, [verse]
      does not only preserve line breaks, but also makes the section
      indented, which causes a slight inconsistency between commands that
      use [verse] and those that don't. Use [verse] in all SYNOPSIS sections
      for consistency.
      
      Also remove the blank lines from git-fetch.txt and git-rebase.txt to
      align with the other man pages. In the case of git-rebase.txt, which
      already uses [verse], the blank line makes the [verse] not apply to
      the last line, so removing the blank line also makes the formatting
      within the document more consistent.
      
      While at it, add single quotes to 'git cvsimport' for consistency with
      other commands.
      Signed-off-by: default avatarMartin von Zweigbergk <martin.von.zweigbergk@gmail.com>
      Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
      7791a1d9
  4. 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
  5. 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
  6. 15 Nov, 2008 1 commit
  7. 05 Jul, 2008 4 commits
  8. 02 Jul, 2008 1 commit
  9. 06 Jun, 2008 1 commit
  10. 28 May, 2008 1 commit
  11. 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
  12. 25 Aug, 2007 1 commit
  13. 23 Jun, 2007 1 commit
    • Shawn O. Pearce's avatar
      Document git-gui, git-citool as mainporcelain manual pages · 37cd4f7e
      Shawn O. Pearce authored
      Jakub Narebski pointed out that the git-gui blame viewer is not a
      widely known feature, but is incredibly useful.  Part of the issue
      is advertising.  Up until now we haven't even referenced git-gui from
      within the core Git manual pages, mostly because I just wasn't sure
      how I wanted to supply git-gui documentation to end-users, or how
      that documentation should integrate with the core Git documentation.
      
      Based upon Jakub's comment that many users may not even know that
      the gui is available in a stock Git distribution I'm offering up
      two basic manual pages: git-citool and git-gui.  These should offer
      enough of a starting point for users to identify that the gui exists,
      and how to start it.  Future releases of git-gui may contain their
      own documentation system available from within a running git-gui.
      But not today.
      Signed-off-by: default avatarShawn O. Pearce <spearce@spearce.org>
      Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
      37cd4f7e