]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: mention trace2 target-dir mode in git-config
authorJosh Steadmon <steadmon@google.com>
Thu, 3 Oct 2019 23:32:56 +0000 (16:32 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 4 Oct 2019 00:26:42 +0000 (09:26 +0900)
Move the description of trace2's target-directory behavior into the
shared trace2-target-values file so that it is included in both the
git-config and api-trace2 docs. Leave the SID discussion only in
api-trace2 since it's a technical detail.

Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-trace2.txt
Documentation/trace2-target-values.txt

index 71eb081fed25a7314a822087056a6c5b9a72d944..80ffceada015886ffb5f72b3f017f2b87e028801 100644 (file)
@@ -142,10 +142,9 @@ system or global config value to one of the following:
 
 include::../trace2-target-values.txt[]
 
-If the target already exists and is a directory, the traces will be
-written to files (one per process) underneath the given directory. They
-will be named according to the last component of the SID (optionally
-followed by a counter to avoid filename collisions).
+When trace files are written to a target directory, they will be named according
+to the last component of the SID (optionally followed by a counter to avoid
+filename collisions).
 
 == Trace2 API
 
index 27d3c64e6655de32492893344e759353e443572a..3985b6d3c2956f7d0b2c5d16d262a5203afe680e 100644 (file)
@@ -2,7 +2,9 @@
 * `0` or `false` - Disables the target.
 * `1` or `true` - Writes to `STDERR`.
 * `[2-9]` - Writes to the already opened file descriptor.
-* `<absolute-pathname>` - Writes to the file in append mode.
+* `<absolute-pathname>` - Writes to the file in append mode. If the target
+already exists and is a directory, the traces will be written to files (one
+per process) underneath the given directory.
 * `af_unix:[<socket_type>:]<absolute-pathname>` - Write to a
 Unix DomainSocket (on platforms that support them).  Socket
 type can be either `stream` or `dgram`; if omitted Git will