git/Documentation/technical/api-strbuf.txt, branch v2.0.2

strbuf: create strbuf_humanise_bytes() to show byte sizes

2013-04-10T19:58:33Z

Humanization of downloaded size is done in the same function as text formatting in 'process.c'. The code cannot be reused easily elsewhere. Separate text formatting from size simplification and make the function public in strbuf so that it can easily be used by other callers. We now can use strbuf_humanise_bytes() for both downloaded size and download speed calculation. One of the drawbacks is that speed will now look like this when download is stalled: "0 bytes/s" instead of "0 KiB/s". Signed-off-by: Antoine Pelisse Signed-off-by: Junio C Hamano

Allow custom "comment char"

2013-01-16T20:48:22Z

Some users do want to write a line that begin with a pound sign, #, in their commit log message. Many tracking system recognise a token of # form, for example. The support we offer these use cases is not very friendly to the end users. They have a choice between - Don't do it. Avoid such a line by rewrapping or indenting; and - Use --cleanup=whitespace but remove all the hint lines we add. Give them a way to set a custom comment char, e.g. $ git -c core.commentchar="%" commit so that they do not have to do either of the two workarounds. [jc: although I started the topic, all the tests and documentation updates, many of the call sites of the new strbuf_add_commented_*() functions, and the change to git-submodule.sh scripted Porcelain are from Ralf.] Signed-off-by: Junio C Hamano Signed-off-by: Ralf Thielow Signed-off-by: Junio C Hamano

strbuf_split*(): document functions

2012-11-04T11:46:55Z

Document strbuf_split_buf(), strbuf_split_str(), strbuf_split_max(), strbuf_split(), and strbuf_list_free() in the header file and in api-strbuf.txt. (These functions were previously completely undocumented.) Signed-off-by: Michael Haggerty Signed-off-by: Jeff King

strbuf: improve strbuf_get*line documentation

2012-02-23T21:52:11Z

Clarify strbuf_getline() documentation, and add the missing documentation for strbuf_getwholeline() and strbuf_getwholeline_fd(). Signed-off-by: Thomas Rast Signed-off-by: Junio C Hamano

strbuf: add strbuf_addbuf_percentquote

2010-01-14T17:25:15Z

This is handy for creating strings which will be fed to printf() or strbuf_expand(). Signed-off-by: Jeff King Signed-off-by: Junio C Hamano

strbuf_expand: convert "%%" to "%"

2010-01-14T17:24:42Z

The only way to safely quote arbitrary text in a pretty-print user format is to replace instances of "%" with "%x25". This is slightly unreadable, and many users would expect "%%" to produce a single "%", as that is what printf format specifiers do. This patch converts "%%" to "%" for all users of strbuf_expand(): (1) git-daemon interpolated paths (2) pretty-print user formats (3) merge driver command lines Case (1) was already doing the conversion itself outside of strbuf_expand(). Case (2) is the intended beneficiary of this patch. Case (3) users probably won't notice, but as this is user-facing behavior, consistently providing the quoting mechanism makes sense. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano

api-strbuf.txt: fix typos and document launch_editor()

2009-12-18T05:54:28Z

Signed-off-by: Stephen Boyd Signed-off-by: Junio C Hamano

Documentation: Typo / spelling / formatting fixes

2009-03-04T05:43:19Z

Signed-off-by: Mike Ralphson Signed-off-by: Junio C Hamano

Merge branch 'maint'

2009-02-04T08:12:19Z

* maint: User-manual: "git stash " form is long gone add test-dump-cache-tree in Makefile fix typo in Documentation apply: fix access to an uninitialized mode variable, found by valgrind Conflicts: Makefile

Merge branch 'maint-1.6.0' into maint

2009-02-04T07:50:09Z

* maint-1.6.0: User-manual: "git stash " form is long gone add test-dump-cache-tree in Makefile fix typo in Documentation apply: fix access to an uninitialized mode variable, found by valgrind