docs: mention trace2 target-dir mode in git-config
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>
Josh Steadmon committed
Oct 3, 2019 at 16:32 UTC
3d4548e7e29177b6a5e21c73009bc40c63c8ce62
2 files changed
+6
-5
Documentation/technical/api-trace2.txt
+3
-4
@@ -142,10 +142,9 @@ system or global config value to one of the following:
142
143
include::../trace2-target-values.txt[]
144
145
-If the target already exists and is a directory, the traces will be
146
-written to files (one per process) underneath the given directory. They
147
-will be named according to the last component of the SID (optionally
148
-followed by a counter to avoid filename collisions).
145
+When trace files are written to a target directory, they will be named according
146
+to the last component of the SID (optionally followed by a counter to avoid
147
+filename collisions).
148
149
== Trace2 API
150
Documentation/trace2-target-values.txt
+3
-1
@@ -2,7 +2,9 @@
2
* `0` or `false` - Disables the target.
3
* `1` or `true` - Writes to `STDERR`.
4
* `[2-9]` - Writes to the already opened file descriptor.
5
-* `<absolute-pathname>` - Writes to the file in append mode.
5
+* `<absolute-pathname>` - Writes to the file in append mode. If the target
6
+already exists and is a directory, the traces will be written to files (one
7
+per process) underneath the given directory.
8
* `af_unix:[<socket_type>:]<absolute-pathname>` - Write to a
9
Unix DomainSocket (on platforms that support them). Socket
10
type can be either `stream` or `dgram`; if omitted Git will