iimprove stagit.1 documentation, reword and explain caching behaviour - stagit-gopher - A git gopher frontend. (mirror) Err bitreich.org 70 hgit clone git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/stagit-gopher/ URL:git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/stagit-gopher/ bitreich.org 70 1Log /scm/stagit-gopher/log.gph bitreich.org 70 1Files /scm/stagit-gopher/files.gph bitreich.org 70 1Refs /scm/stagit-gopher/refs.gph bitreich.org 70 1Tags /scm/stagit-gopher/tag bitreich.org 70 1README /scm/stagit-gopher/file/README.gph bitreich.org 70 1LICENSE /scm/stagit-gopher/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 1commit f8e30cf2a0398120bca874bafe170857426a1780 /scm/stagit-gopher/commit/f8e30cf2a0398120bca874bafe170857426a1780.gph bitreich.org 70 1parent 2f8595e786809234d66d8abca519e39f6b1d701a /scm/stagit-gopher/commit/2f8595e786809234d66d8abca519e39f6b1d701a.gph bitreich.org 70 hAuthor: Hiltjo Posthuma URL:mailto:hiltjo@codemadness.org bitreich.org 70 iDate: Sat, 7 May 2016 14:33:36 +0200 Err bitreich.org 70 i Err bitreich.org 70 iimprove stagit.1 documentation, reword and explain caching behaviour Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i M stagit.1 | 25 +++++++++++++++++-------- Err bitreich.org 70 i Err bitreich.org 70 i1 file changed, 17 insertions(+), 8 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/stagit.1 b/stagit.1 /scm/stagit-gopher/file/stagit.1.gph bitreich.org 70 i@@ -22,8 +22,7 @@ the last commit. The Err bitreich.org 70 i will store the last commit id and the entries in the HTML table. It is up Err bitreich.org 70 i to the user to make sure the state of the Err bitreich.org 70 i .Ar cachefile Err bitreich.org 70 i-is in sync with the history of the repository, for example a Err bitreich.org 70 i-git push \-\-force can screw this up. Err bitreich.org 70 i+is in sync with the history of the repository. Err bitreich.org 70 i .Pp Err bitreich.org 70 i The following files will be written: Err bitreich.org 70 i .Bl -tag -width Ds Err bitreich.org 70 i@@ -38,20 +37,30 @@ each commit links to a page with a diff and diffstat of the commit. Err bitreich.org 70 i Lists references of the repository such as branches and tags. Err bitreich.org 70 i .El Err bitreich.org 70 i .Pp Err bitreich.org 70 i-For each file in HEAD a file will be written in the format: Err bitreich.org 70 i+For each entry in HEAD a file will be written in the format: Err bitreich.org 70 i file/filepath.html. This file will contain the textual data of the file Err bitreich.org 70 i-prefixed by line numbers. The file will have the string "binary file" Err bitreich.org 70 i+prefixed by line numbers. The file will have the string "Binary file" Err bitreich.org 70 i if the data is considered to be non-textual. Err bitreich.org 70 i .Pp Err bitreich.org 70 i For each commit a file will be written in the format: Err bitreich.org 70 i-commit/commitid.html . This file will contain the diff and diffstat of the Err bitreich.org 70 i-commit. It will write the string "binary files differ" if the data is Err bitreich.org 70 i-considered to be non-textual. Err bitreich.org 70 i+commit/commitid.html. This file will contain the diff and diffstat of the Err bitreich.org 70 i+commit. It will write the string "Binary files differ" if the data is Err bitreich.org 70 i+considered to be non-textual. Too large diffs will be suppressed and a string Err bitreich.org 70 i+"Diff is too large, output suppressed" will be written. Err bitreich.org 70 i+.Pp Err bitreich.org 70 i+When a commit HTML file exists it won't be overwritten again, note that if Err bitreich.org 70 i+you've changed Err bitreich.org 70 i+.Nm Err bitreich.org 70 i+or changed one of the metadata files of the repository it is recommended to Err bitreich.org 70 i+recreate all the output files because it will contain old data. To do this Err bitreich.org 70 i+remove the output directory and Err bitreich.org 70 i+.Ar cachefile , Err bitreich.org 70 i+then recreate the files. Err bitreich.org 70 i .Pp Err bitreich.org 70 i The basename of the directory is used as the name. The suffix ".git" is Err bitreich.org 70 i removed from the basename, this is commonly used for "bare" repos. Err bitreich.org 70 i .Pp Err bitreich.org 70 i-The content of the follow files specifies the meta data for each repository: Err bitreich.org 70 i+The content of the follow files specifies the metadata for each repository: Err bitreich.org 70 i .Bl -tag -width Ds Err bitreich.org 70 i .It .git/description or description (bare repo). Err bitreich.org 70 i description Err bitreich.org 70 .