improve git-diff documentation and A...B handling

#1 Open

Bitbucket cannot automatically merge this request.

The commits that make up this pull request have been removed.

Bitbucket cannot automatically merge this request due to conflicts.

Review the conflicts on the Overview tab. You can then either decline the request or merge it manually on your local system using the following commands:

git checkout master
git merge --no-ff -m 'Merged in forgeperf (pull request #1)' remotes/origin/forgeperf
  1. Drew DeVault
git diff -h help is succinct, but perhaps too much so.

The symmetric-diff syntax, git diff A...B, is defined by the documentation
to compare the merge base of A and B to commit B. It does so just fine when
there is a merge base. It compares A and B directly if there is no merge
base, and it is overly forgiving of bad arguments after which it can produce
nonsensical diffs.

The first patch simply adjusts a test that will fail if the second patch is
accepted. The second patch adds special handling for the symmetric diff
syntax so that the option parsing works, plus a small test suite. The third
patch just updates the SYNOPSIS section of the documentation and makes the
help output more verbose (to match the SYNOPSIS and provide common diff
options like git-diff-files, for instance).

Comments (16)

  1. Drew DeVault author

    Welcome to GitGitGadget

    Hi chris3torek, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

    Please make sure that your Pull Request has a good description, as it will be used as cover letter.

    Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

    • the lines should not exceed 76 columns,
    • the first line should be like a header and typically start with a prefix like "tests:" or "commit:", and
    • the commit messages' body should be describing the "why?" of the change.
    • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

    It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

    Contributing the patches

    Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

    Both the person who commented /allow and the PR author are able to /allow you.

    An alternative is the channel #git-devel on the FreeNode IRC network:

    <newcontributor> I've just created my first PR, could someone please /allow me? <>
    <veteran> newcontributor: it is done
    <newcontributor> thanks!

    Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

    If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this.

    After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

    If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

    curl -g --user "<EMailAddress>:<Password>" \
        --url "imaps://" -T /path/to/raw.txt

    To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

    Changes since v1:
    - Fixed a typo in the commit message (found by ...)
    - Added a code comment to ... as suggested by ...

    To send a new iteration, just add another PR comment with the contents: /submit.

    Need help?

    New contributors who want advice are encouraged to join, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

    You may also be able to find help in real time in the developer IRC channel, #git-devel on Freenode. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.