diff options
| author | Junio C Hamano <gitster@pobox.com> | 2013-02-04 10:23:49 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-02-04 10:23:49 -0800 |
| commit | 149a4211a4b8d8bbcdd72685d538d6ac7365e29e (patch) | |
| tree | f0e37272889876737f0216021ea8d23785763fa2 /Documentation | |
| parent | bcd45b4085f9269a536c8fb1963ac8380bfac0e8 (diff) | |
| parent | eff80a9fd990de3605063050dae32f969ef18ba8 (diff) | |
| download | git-149a4211a4b8d8bbcdd72685d538d6ac7365e29e.tar.gz | |
Merge branch 'jc/custom-comment-char'
Allow a configuration variable core.commentchar to customize the
character used to comment out the hint lines in the edited text from
the default '#'.
* jc/custom-comment-char:
Allow custom "comment char"
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/config.txt | 6 | ||||
| -rw-r--r-- | Documentation/git-stripspace.txt | 8 | ||||
| -rw-r--r-- | Documentation/technical/api-strbuf.txt | 10 |
3 files changed, 23 insertions, 1 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index d7ec507003..10225cfaf7 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -534,6 +534,12 @@ core.editor:: variable when it is set, and the environment variable `GIT_EDITOR` is not set. See linkgit:git-var[1]. +core.commentchar:: + Commands such as `commit` and `tag` that lets you edit + messages consider a line that begins with this character + commented, and removes them after the editor returns + (default '#'). + sequence.editor:: Text editor used by `git rebase -i` for editing the rebase insn file. The value is meant to be interpreted by the shell when it is used. diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt index a80d94650d..e6fdfcb994 100644 --- a/Documentation/git-stripspace.txt +++ b/Documentation/git-stripspace.txt @@ -35,7 +35,13 @@ OPTIONS ------- -s:: --strip-comments:: - Skip and remove all lines starting with '#'. + Skip and remove all lines starting with comment character (default '#'). + +-c:: +--comment-lines:: + Prepend comment character and blank to each line. Lines will automatically + be terminated with a newline. On empty lines, only the comment character + will be prepended. EXAMPLES -------- diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index 84686b5c69..2c59cb2259 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@ -156,6 +156,11 @@ then they will free() it. Remove the bytes between `pos..pos+len` and replace it with the given data. +`strbuf_add_commented_lines`:: + + Add a NUL-terminated string to the buffer. Each line will be prepended + by a comment character and a blank. + `strbuf_add`:: Add data of given length to the buffer. @@ -229,6 +234,11 @@ which can be used by the programmer of the callback as she sees fit. Add a formatted string to the buffer. +`strbuf_commented_addf`:: + + Add a formatted string prepended by a comment character and a + blank to the buffer. + `strbuf_fread`:: Read a given size of data from a FILE* pointer to the buffer. |