{"thread":{"id":"32577","subject":"[PATCH v2 1/2] git-fast-import(1): combine documentation of --[no-]relative-marks","startedAt":"2013-01-09T19:43:16Z","lastAt":"2013-01-09T22:21:59Z","messageCount":5,"participants":["John Keeping","Jonathan Nieder","Junio C Hamano"],"isPatch":true,"patchVersion":2,"patchTotal":2},"messages":[{"id":"206412","messageId":"cover.1357760256.git.john@keeping.me.uk","threadId":"32577","inReplyTo":"7va9slnc07.fsf@alter.siamese.dyndns.org","subject":"[PATCH v2 0/2] Reorganise options in git-fast-import(1)","fromName":"John Keeping","fromEmail":"john@keeping.me.uk","sentAt":"2013-01-09T19:43:16Z","receivedAt":"2013-01-09T19:43:16Z","isPatch":true,"sender":{"key":"john@keeping.me.uk","avatar":"https://avatars.githubusercontent.com/u/1702081?v=4"},"body":"Here's a second attempt at this taking into account the feedback received so far.\n\nChanges since v1:\n\n * Left dedup '--done' as a separate patch (now merged)\n * Split combining '--[no-]relative-marks' into a separate patch\n * '--force' moved to the top of the options, making the catchall\n section alphabetically sorted\n * Section headings changed:\n 'Options related to the input stream' => 'Options for Frontends'\n 'Options related to marks' => 'Locations of Marks Files'\n 'Options for tuning' => 'Performance and Compression Tuning'\n * '--export-pack-edges' moves to 'Performance and Compression Tuning'\n * '--cat-blob-fd' moves to 'Options for Frontends'\n\n\nJohn Keeping (2):\n git-fast-import(1): combine documentation of --[no-]relative-marks\n git-fast-import(1): reorganise options\n\n Documentation/git-fast-import.txt | 98 +++++++++++++++++++++------------------\n 1 file changed, 52 insertions(+), 46 deletions(-)\n\n-- \n1.8.1.468.g3d9f9b6\n"},{"id":"206411","messageId":"cf4a4a10c1de73491048e8283582bdbf8c79c75e.1357760256.git.john@keeping.me.uk","threadId":"32577","inReplyTo":"cover.1357760256.git.john@keeping.me.uk","subject":"[PATCH v2 1/2] git-fast-import(1): combine documentation of --[no-]relative-marks","fromName":"John Keeping","fromEmail":"john@keeping.me.uk","sentAt":"2013-01-09T19:44:38Z","receivedAt":"2013-01-09T19:44:38Z","isPatch":true,"sender":{"key":"john@keeping.me.uk","avatar":"https://avatars.githubusercontent.com/u/1702081?v=4"},"body":"The descriptions of '--relative-marks' and '--no-relative-marks' make\nmore sense when read together instead of as two independent options.\nCombine them into a single description block.\n\nSigned-off-by: John Keeping \n---\n Documentation/git-fast-import.txt | 10 ++++------\n 1 file changed, 4 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt\nindex 3da5cc2..75ce808 100644\n--- a/Documentation/git-fast-import.txt\n+++ b/Documentation/git-fast-import.txt\n@@ -83,19 +83,17 @@ OPTIONS\n \tLike --import-marks but instead of erroring out, silently\n \tskips the file if it does not exist.\n \n---relative-marks::\n+--[no-]relative-marks::\n \tAfter specifying --relative-marks the paths specified\n \twith --import-marks= and --export-marks= are relative\n \tto an internal directory in the current repository.\n \tIn git-fast-import this means that the paths are relative\n \tto the .git/info/fast-import directory. However, other\n \timporters may use a different location.\n++\n+Relative and non-relative marks may be combined by interweaving\n+--(no-)-relative-marks with the --(import|export)-marks= options.\n \n---no-relative-marks::\n-\tNegates a previous --relative-marks. Allows for combining\n-\trelative and non-relative marks by interweaving\n-\t--(no-)-relative-marks with the --(import|export)-marks=\n-\toptions.\n \n --cat-blob-fd=::\n \tWrite responses to `cat-blob` and `ls` queries to the\n-- \n1.8.1.468.g3d9f9b6\n"},{"id":"206415","messageId":"e228dd4522dbf7ebfe0e5207b1dcc9591faa4d15.1357760256.git.john@keeping.me.uk","threadId":"32577","inReplyTo":"cover.1357760256.git.john@keeping.me.uk","subject":"[PATCH v2 2/2] git-fast-import(1): reorganise options","fromName":"John Keeping","fromEmail":"john@keeping.me.uk","sentAt":"2013-01-09T19:45:29Z","receivedAt":"2013-01-09T19:45:29Z","isPatch":true,"sender":{"key":"john@keeping.me.uk","avatar":"https://avatars.githubusercontent.com/u/1702081?v=4"},"body":"The options in git-fast-import(1) are not currently arranged in a\nlogical order, which has caused the '--done' options to be documented\ntwice (commit 3266de10).\n\nRearrange them into logical groups under subheadings.\n\nSuggested-by: Jonathan Nieder \nSigned-off-by: John Keeping \n\n---\n Documentation/git-fast-import.txt | 88 +++++++++++++++++++++------------------\n 1 file changed, 48 insertions(+), 40 deletions(-)\n\ndiff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt\nindex 75ce808..bf1a02a 100644\n--- a/Documentation/git-fast-import.txt\n+++ b/Documentation/git-fast-import.txt\n@@ -33,34 +33,46 @@ the frontend program in use.\n \n OPTIONS\n -------\n---date-format=::\n-\tSpecify the type of dates the frontend will supply to\n-\tfast-import within `author`, `committer` and `tagger` commands.\n-\tSee ``Date Formats'' below for details about which formats\n-\tare supported, and their syntax.\n \n --force::\n \tForce updating modified existing branches, even if doing\n \tso would cause commits to be lost (as the new commit does\n \tnot contain the old commit).\n \n---max-pack-size=::\n-\tMaximum size of each output packfile.\n-\tThe default is unlimited.\n+--quiet::\n+\tDisable all non-fatal output, making fast-import silent when it\n+\tis successful. This option disables the output shown by\n+\t\\--stats.\n \n---big-file-threshold=::\n-\tMaximum size of a blob that fast-import will attempt to\n-\tcreate a delta for, expressed in bytes. The default is 512m\n-\t(512 MiB). Some importers may wish to lower this on systems\n-\twith constrained memory.\n+--stats::\n+\tDisplay some basic statistics about the objects fast-import has\n+\tcreated, the packfiles they were stored into, and the\n+\tmemory used by fast-import during this run. Showing this output\n+\tis currently the default, but can be disabled with \\--quiet.\n \n---depth=::\n-\tMaximum delta depth, for blob and tree deltification.\n-\tDefault is 10.\n+Options for Frontends\n+~~~~~~~~~~~~~~~~~~~~~\n \n---active-branches=::\n-\tMaximum number of branches to maintain active at once.\n-\tSee ``Memory Utilization'' below for details. Default is 5.\n+--cat-blob-fd=::\n+\tWrite responses to `cat-blob` and `ls` queries to the\n+\tfile descriptor instead of `stdout`. Allows `progress`\n+\toutput intended for the end-user to be separated from other\n+\toutput.\n+\n+--date-format=::\n+\tSpecify the type of dates the frontend will supply to\n+\tfast-import within `author`, `committer` and `tagger` commands.\n+\tSee ``Date Formats'' below for details about which formats\n+\tare supported, and their syntax.\n+\n+--done::\n+\tTerminate with error if there is no `done` command at the end of\n+\tthe stream. This option might be useful for detecting errors\n+\tthat cause the frontend to terminate before it has started to\n+\twrite a stream.\n+\n+Locations of Marks Files\n+~~~~~~~~~~~~~~~~~~~~~~~~\n \n --export-marks=::\n \tDumps the internal marks table to when complete.\n@@ -94,19 +106,22 @@ OPTIONS\n Relative and non-relative marks may be combined by interweaving\n --(no-)-relative-marks with the --(import|export)-marks= options.\n \n+Performance and Compression Tuning\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n---cat-blob-fd=::\n-\tWrite responses to `cat-blob` and `ls` queries to the\n-\tfile descriptor instead of `stdout`. Allows `progress`\n-\toutput intended for the end-user to be separated from other\n-\toutput.\n+--active-branches=::\n+\tMaximum number of branches to maintain active at once.\n+\tSee ``Memory Utilization'' below for details. Default is 5.\n \n---done::\n-\tTerminate with error if there is no `done` command at the\n-\tend of the stream.\n-\tThis option might be useful for detecting errors that\n-\tcause the frontend to terminate before it has started to\n-\twrite a stream.\n+--big-file-threshold=::\n+\tMaximum size of a blob that fast-import will attempt to\n+\tcreate a delta for, expressed in bytes. The default is 512m\n+\t(512 MiB). Some importers may wish to lower this on systems\n+\twith constrained memory.\n+\n+--depth=::\n+\tMaximum delta depth, for blob and tree deltification.\n+\tDefault is 10.\n \n --export-pack-edges=::\n \tAfter creating a packfile, print a line of data to\n@@ -117,16 +132,9 @@ Relative and non-relative marks may be combined by interweaving\n \tas these commits can be used as edge points during calls\n \tto 'git pack-objects'.\n \n---quiet::\n-\tDisable all non-fatal output, making fast-import silent when it\n-\tis successful. This option disables the output shown by\n-\t\\--stats.\n-\n---stats::\n-\tDisplay some basic statistics about the objects fast-import has\n-\tcreated, the packfiles they were stored into, and the\n-\tmemory used by fast-import during this run. Showing this output\n-\tis currently the default, but can be disabled with \\--quiet.\n+--max-pack-size=::\n+\tMaximum size of each output packfile.\n+\tThe default is unlimited.\n \n \n Performance\n-- \n1.8.1.468.g3d9f9b6\n"},{"id":"206429","messageId":"20130109214246.GA21054@google.com","threadId":"32577","inReplyTo":"cf4a4a10c1de73491048e8283582bdbf8c79c75e.1357760256.git.john@keeping.me.uk","subject":"Re: [PATCH v2 1/2] git-fast-import(1): combine documentation of --[no-]relative-marks","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2013-01-09T21:42:46Z","receivedAt":"2013-01-09T21:42:46Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"John Keeping wrote:\n\n> The descriptions of '--relative-marks' and '--no-relative-marks' make\n> more sense when read together instead of as two independent options.\n> Combine them into a single description block.\n\nYep, this is easier to read. Thanks.\n\nReviewed-by: Jonathan Nieder \n"},{"id":"206432","messageId":"7v1udu3sl4.fsf@alter.siamese.dyndns.org","threadId":"32577","inReplyTo":"e228dd4522dbf7ebfe0e5207b1dcc9591faa4d15.1357760256.git.john@keeping.me.uk","subject":"Re: [PATCH v2 2/2] git-fast-import(1): reorganise options","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2013-01-09T22:21:59Z","receivedAt":"2013-01-09T22:21:59Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Thanks.\n"}]}