index : sparkle-git.git

ascending towards madness

author holly sparkles <sparkles@holly.sh> 2023-12-24 15:54:29.0 +00:00:00
committer holly sparkles <sparkles@holly.sh> 2024-05-14 6:40:47.0 +00:00:00
commit
7f03068ace3cae1ed932e9cf33bc276b0c9ac527 [patch]
tree
3414fe601f76540f242354355342ac08a8d85f0f
parent
97acdfc01b43c4a016eee537b01fda7c956093fe
download
7f03068ace3cae1ed932e9cf33bc276b0c9ac527.tar.gz

docs(man): add sections on commit message and repo desc truncating

- max_commit_message_length
- max_repo_desc_length

Diff

 doc/man/rgitrc.5    | 21 +++++++++++++++++++++
 doc/man/rgitrc.5.md | 16 ++++++++++++++++
 2 files changed, 37 insertions(+)

diff --git a/doc/man/rgitrc.5 b/doc/man/rgitrc.5
index 6e21d3e..b89b81f 100644
--- a/doc/man/rgitrc.5
+++ b/doc/man/rgitrc.5
@@ -124,6 +124,27 @@ Default value: \[lq]/\[rq]
See also: \f[V]logo\f[R], \f[V]logo_alt\f[R]
.RE
.TP
\f[B]max_commit_message_length\f[R]
Specifies the maximum number of commit message characters to display in
\[lq]log\[rq] view.
.RS
.PP
If unset or set to \[lq]0\[rq], commit messages will not be truncated.
.PP
Default value: \[lq]0\[rq]
.RE
.TP
\f[B]max_repo_desc_length\f[R]
Specifies the maximum number of description characters to display on the
repository index page.
.RS
.PP
If unset or set to \[lq]0\[rq], repository descriptions will not be
truncated.
.PP
Default value: \[lq]0\[rq]
.RE
.TP
\f[B]root_description\f[R]
Text printed below the heading (\f[V]root_title\f[R]) on the repository
index page.
diff --git a/doc/man/rgitrc.5.md b/doc/man/rgitrc.5.md
index 0266f81..e8d0f56 100644
--- a/doc/man/rgitrc.5.md
+++ b/doc/man/rgitrc.5.md
@@ -104,6 +104,22 @@ GLOBAL SETTINGS
    `logo`,
    `logo_alt`

**max_commit_message_length**

:   Specifies the maximum number of commit message characters to display in "log" view.

    If unset or set to "0", commit messages will not be truncated.

    Default value: "0"

**max_repo_desc_length**

:   Specifies the maximum number of description characters to display on the repository index page.

    If unset or set to "0", repository descriptions will not be truncated.

    Default value: "0"

**root_description**

:   Text printed below the heading (`root_title`) on the repository index page.