Skip to content

Commit b3c4ad6

Browse files
committed
Docs: add missing description for the '--message' parameter
1 parent 3d1a8d2 commit b3c4ad6

File tree

4 files changed

+25
-5
lines changed

4 files changed

+25
-5
lines changed

doc/html/serge-push.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ <h1 id="OPTIONS">OPTIONS</h1>
3838

3939
<dl>
4040

41+
<dt><b>--message=&quot;commit message&quot;</b></dt>
42+
<dd>
43+
44+
<p>When pushing localized data back to version control, override the commit message with the provided one.</p>
45+
46+
</dd>
4147
<dt><b>--echo-commands</b></dt>
4248
<dd>
4349

doc/html/serge-sync.html

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,31 +39,37 @@ <h1 id="OPTIONS">OPTIONS</h1>
3939
<dt><b>--force</b></dt>
4040
<dd>
4141

42-
<p>Has the same effect as <a href="serge-pull-ts.html"><code>serge pull-ts --force</code></a> and <a href="serge-localize.html"><code>serge localize --force</code></a> combined.</p>
42+
<p>Has the same effect as <code><a href="serge-pull-ts.html">serge pull-ts --force</a></code> and <code><a href="serge-localize.html">serge localize --force</a></code> combined.</p>
4343

4444
</dd>
4545
<dt><b>--rebuild-ts-files</b></dt>
4646
<dd>
4747

48-
<p>Has the same effect as <a href="serge-localize.html"><code>serge localize --rebuild-ts-files</code></a>.</p>
48+
<p>Has the same effect as <code><a href="serge-localize.html">serge localize --rebuild-ts-files</a></code>.</p>
4949

5050
</dd>
5151
<dt><b>--output-only-mode</b></dt>
5252
<dd>
5353

54-
<p>Has the same effect as <a href="serge-localize.html"><code>serge localize --output-only-mode</code></a>.</p>
54+
<p>Has the same effect as <code><a href="serge-localize.html">serge localize --output-only-mode</a></code>.</p>
5555

5656
</dd>
5757
<dt><b>--lang=xx[,yy][,zz]</b>, <b>--language=xx[,yy][,zz]</b> <b>--languages=xx[,yy][,zz]</b></dt>
5858
<dd>
5959

60-
<p>See <a href="serge-localize.html"><code>serge localize --lang</code></a>. Will also completely skip processing configs where no target languages are found.</p>
60+
<p>See <code><a href="serge-localize.html">serge localize --lang</a></code>. Will also completely skip processing configs where no target languages are found.</p>
6161

6262
</dd>
6363
<dt><b>--job=xx[,yy][,zz]</b>, <b>--jobs=xx[,yy][,zz]</b></dt>
6464
<dd>
6565

66-
<p>See <a href="serge-localize.html"><code>serge localize --job</code></a>. Will also completely skip processing configs where no target jobs are found.</p>
66+
<p>See <code><a href="serge-localize.html">serge localize --job</a></code>. Will also completely skip processing configs where no target jobs are found.</p>
67+
68+
</dd>
69+
<dt><b>--message=&quot;commit message&quot;</b></dt>
70+
<dd>
71+
72+
<p>When pushing localized data back to version control, override the commit message with the provided one.</p>
6773

6874
</dd>
6975
<dt><b>--echo-commands</b></dt>

doc/pod/serge-push.pod

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ not be the one you are doing any development in.
2626

2727
=over 8
2828

29+
=item B<--message="commit message">
30+
31+
When pushing localized data back to version control, override the commit message with the provided one.
32+
2933
=item B<--echo-commands>
3034

3135
Echo system commands about to be executed (useful for debugging)

doc/pod/serge-sync.pod

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ no target languages are found.
4444
See C<< L<serge localize --job|serge-localize> >>. Will also completely skip processing configs where
4545
no target jobs are found.
4646

47+
=item B<--message="commit message">
48+
49+
When pushing localized data back to version control, override the commit message with the provided one.
50+
4751
=item B<--echo-commands>
4852

4953
Echo system commands about to be executed (useful for debugging)

0 commit comments

Comments
 (0)