{"thread":{"id":"2759","subject":"A list of things missing or wrong in the documentation","startedAt":"2005-12-06T22:12:52Z","lastAt":"2005-12-06T22:12:52Z","messageCount":1,"participants":["Nikolai Weibull"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"13286","messageId":"20051206221252.GA8839@puritan.petwork","threadId":"2759","inReplyTo":null,"subject":"A list of things missing or wrong in the documentation","fromName":"Nikolai Weibull","fromEmail":"mailing-lists.git@rawuncut.elitemail.org","sentAt":"2005-12-06T22:12:52Z","receivedAt":"2005-12-06T22:12:52Z","isPatch":false,"sender":{"key":"mailing-lists.git@rawuncut.elitemail.org","avatar":null},"body":"Here's a list of things that are missing, wrong, or badly formatted in\nthe documentation (all checked against the man pages):\n\ngit-checkout-index:\n        SYNOPSIS:\n                --index\n                --quiet\n                --force\n                --all\n                --no-create\n\n                (How do we put these in the SYNOPSIS?)\n                (My bad, forgot to mention this in an earlier patch.)\n\ngit-read-tree:\n        --trivial\n\n        SYNOPSIS:\n                --reset\n\ngit-update-index:\n        -h\n        --help\n\n        (perhaps redundant)\n\ngit-rev-list:\n        --dense\n        --no-merges\n\ngit-merge-base:\n        -a, --all\n\ngit-verify-pack:\n        --\n\ngit-http-fetch:\n        commit-id and url are missing descriptions\n\ngit-update-server-info:\n        -f\n\ngit-am:\n        --utf8 is converted to -u\n        --keep is converted to -k\n\ngit-bisect:\n        Documentation is messed up.  Lines are being joined when they\n        shouldn't be (put \"+ \" at end of line).\n\ngit-cherry-pick:\n        --no-commit\n        --replay\n\ngit-clone:\n        SYNOPSIS:\n                --local\n                --shared\n                --quiet\n                --upload-pack\n\ngit-commit:\n        --all\n        --signoff\n        --verify\n        --no-verify\n        --edit\n        -n\n\ngit-diff:\n        --diff-options should be <common diff options>\n\n        The table isn't rendered properly in the man-page.  I'm guessing\n        that this is a problem with my DocBook templates, but I wanted\n        to check if anyone else has this issue.\n\ngit-format-patch:\n        SYNOPSIS:\n                provide spacing around options, like other man-pages\n\n        --keep-subject\n        --numbered\n        --output-directory\n        -h --help\n        -m\n        -d\n\ngit-ls-remote:\n        -h\n        -t\n        \ngit-pull:\n        --strategy\n\ngit-repack:\n        -n\n        -l\n\ngit-revert:\n        --no-commit\n        -r --replay\n\ngit-show-branch:\n        --topo-order\n\ngit-cvsimport:\n        error in spacing (-P)\n\ngit-prune:\n        --\n\ngit-tag:\n        doesn't follow the format of the other manual pages\n        missing explicit documentation for many options\n\nGeneral:\n        The term \"commit-id\" isn't listed in the glossary.  Should this\n        be changed to \"commit\" instead?\n\n        Style guides generally suggest putting a comma after \"e.g.\" and\n        \"i.e.\", i.e., \"e.g.,\" and \"i.e.,\".  It's perhaps a bit anal, but\n        what do you think?\n\n        rev is used as a term in some places.  Should perhaps expand it\n        to revision?\n\nI should of course provide patches for this, but I'm quite a bit under\nthe weather at the moment, and as a 1.0.0 release draws near I figured\nthat it'd be best that people at least know what I know so that they may\ndo something about it.  (Also, someone with better knowledge of asciidoc\nand git itself would probably do a better job than I could.)\n\n        nikolai\n\n-- \nNikolai Weibull: now available free of charge at http://bitwi.se/!\nBorn in Chicago, IL USA; currently residing in Gothenburg, Sweden.\nmain(){printf(&linux[\"\\021%six\\012\\0\"],(linux)[\"have\"]+\"fun\"-97);}\n"}]}