1. 28 Feb, 2014 1 commit
  2. 17 May, 2013 1 commit
  3. 12 Apr, 2013 1 commit
  4. 01 Feb, 2013 1 commit
  5. 26 Apr, 2012 1 commit
    • Jeff King's avatar
      docs: stop using asciidoc no-inline-literal · 6cf378f0
      Jeff King authored
      In asciidoc 7, backticks like `foo` produced a typographic
      effect, but did not otherwise affect the syntax. In asciidoc
      8, backticks introduce an "inline literal" inside which markup
      is not interpreted. To keep compatibility with existing
      documents, asciidoc 8 has a "no-inline-literal" attribute to
      keep the old behavior. We enabled this so that the
      documentation could be built on either version.
      
      It has been several years now, and asciidoc 7 is no longer
      in wide use. We can now decide whether or not we want
      inline literals on their own merits, which are:
      
        1. The source is much easier to read when the literal
           contains punctuation. You can use `master~1` instead
           of `master{tilde}1`.
      
        2. They are less error-prone. Because of point (1), we
           tend to make mistakes and forget the extra layer of
           quoting.
      
      This patch removes the no-inline-literal attribute from the
      Makefile and converts every use of backticks in the
      documentation to an inline literal (they must be cleaned up,
      or the example above would literally show "{tilde}" in the
      output).
      
      Problematic sites were found by grepping for '`.*[{\\]' and
      examined and fixed manually. The results were then verified
      by comparing the output of "html2text" on the set of
      generated html pages. Doing so revealed that in addition to
      making the source more readable, this patch fixes several
      formatting bugs:
      
        - HTML rendering used the ellipsis character instead of
          literal "..." in code examples (like "git log A...B")
      
        - some code examples used the right-arrow character
          instead of '->' because they failed to quote
      
        - api-config.txt did not quote tilde, and the resulting
          HTML contained a bogus snippet like:
      
            <tt><sub></tt> foo <tt></sub>bar</tt>
      
          which caused some parsers to choke and omit whole
          sections of the page.
      
        - git-commit.txt confused ``foo`` (backticks inside a
          literal) with ``foo'' (matched double-quotes)
      
        - mentions of `A U Thor <[email protected]>` used to
          erroneously auto-generate a mailto footnote for
          [email protected]
      
        - the description of --word-diff=plain incorrectly showed
          the output as "[-removed-] and {added}", not "{+added+}".
      
        - using "prime" notation like:
      
            commit `C` and its replacement `C'`
      
          confused asciidoc into thinking that everything between
          the first backtick and the final apostrophe were meant
          to be inside matched quotes
      
        - asciidoc got confused by the escaping of some of our
          asterisks. In particular,
      
            `credential.\*` and `credential.<url>.\*`
      
          properly escaped the asterisk in the first case, but
          literally passed through the backslash in the second
          case.
      Signed-off-by: default avatarJeff King <[email protected]>
      Signed-off-by: default avatarJunio C Hamano <[email protected]>
      6cf378f0
  6. 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 <[email protected]>
      Signed-off-by: default avatarJunio C Hamano <[email protected]>
      5d2fc913
  7. 22 Jun, 2011 3 commits
  8. 14 Apr, 2011 1 commit
  9. 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 [email protected], 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
  10. 10 Jan, 2011 1 commit
  11. 08 Oct, 2010 1 commit
  12. 12 Feb, 2010 1 commit
  13. 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
  14. 04 Dec, 2009 1 commit
  15. 13 Sep, 2009 2 commits
  16. 28 Aug, 2009 1 commit
  17. 18 Apr, 2009 1 commit
  18. 17 Mar, 2009 1 commit
  19. 04 Mar, 2009 2 commits
  20. 05 Jul, 2008 1 commit
  21. 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 <[email protected]>
      Signed-off-by: default avatarJunio C Hamano <[email protected]>
      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 <[email protected]>
      Signed-off-by: default avatarJunio C Hamano <[email protected]>
      b1889c36
  22. 08 Jun, 2008 1 commit
    • Stephan Beyer's avatar
      Docs: Use "-l::\n--long\n" format in OPTIONS sections · 3240240f
      Stephan Beyer authored
      The OPTIONS section of a documentation file contains a list
      of the options a git command accepts.
      
      Currently there are several variants to describe the case that
      different options (almost) do the same in the OPTIONS section.
      
      Some are:
      
       -f, --foo::
       -f|--foo::
       -f | --foo::
      
      But AsciiDoc has the special form:
      
       -f::
       --foo::
      
      This patch applies this form to the documentation of the whole git suite,
      and removes useless em-dash prevention, so \--foo becomes --foo.
      Signed-off-by: default avatarStephan Beyer <[email protected]>
      Signed-off-by: default avatarJunio C Hamano <[email protected]>
      3240240f
  23. 06 Jun, 2008 1 commit
  24. 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 <[email protected]>
      Signed-off-by: default avatarJunio C Hamano <[email protected]>
      5162e697
  25. 16 Oct, 2007 1 commit
  26. 14 Sep, 2007 1 commit
  27. 22 Aug, 2007 1 commit
  28. 09 Jun, 2007 1 commit
  29. 19 May, 2007 1 commit
  30. 19 Apr, 2007 1 commit
  31. 10 Apr, 2007 1 commit
  32. 18 Jan, 2007 1 commit
  33. 26 Sep, 2006 1 commit
  34. 09 Sep, 2006 1 commit
    • Franck Bui-Huu's avatar
      Add git-archive · 4df096a5
      Franck Bui-Huu authored
      git-archive is a command to make TAR and ZIP archives of a git tree.
      It helps prevent a proliferation of git-{format}-tree commands.
      
      Instead of directly calling git-{tar,zip}-tree command, it defines
      a very simple API, that archiver should implement and register in
      "git-archive.c". This API is made up by 2 functions whose prototype
      is defined in "archive.h" file.
      
       - The first one is used to parse 'extra' parameters which have
         signification only for the specific archiver. That would allow
         different archive backends to have different kind of options.
      
       - The second one is used to ask to an archive backend to build
         the archive given some already resolved parameters.
      
      The main reason for making this API is to avoid using
      git-{tar,zip}-tree commands, hence making them useless. Maybe it's
      time for them to die ?
      
      It also implements remote operations by defining a very simple
      protocol: it first sends the name of the specific uploader followed
      the repository name (git-upload-tar git://example.org/repo.git).
      Then it sends options. It's done by sending a sequence of one
      argument per packet, with prefix "argument ", followed by a flush.
      
      The remote protocol is implemented in "git-archive.c" for client
      side and is triggered by "--remote=<repo>" option. For example,
      to fetch a TAR archive in a remote repo, you can issue:
      
      $ git archive --format=tar --remote=git://xxx/yyy/zzz.git HEAD
      
      We choose to not make a new command "git-fetch-archive" for example,
      avoind one more GIT command which should be nice for users (less
      commands to remember, keeps existing --remote option).
      Signed-off-by: default avatarFranck Bui-Huu <[email protected]>
      Acked-by: default avatarRene Scharfe <[email protected]>
      Signed-off-by: default avatarJunio C Hamano <[email protected]>
      4df096a5