iimprove documentation - 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 8eabe24bdda7003453bbd034d82ebc479e2c76bc /scm/stagit-gopher/commit/8eabe24bdda7003453bbd034d82ebc479e2c76bc.gph bitreich.org 70 1parent e9e7978381a2b3567902420d5ea1539d3c695b31 /scm/stagit-gopher/commit/e9e7978381a2b3567902420d5ea1539d3c695b31.gph bitreich.org 70 hAuthor: Hiltjo Posthuma URL:mailto:hiltjo@codemadness.org bitreich.org 70 iDate: Sat, 22 Apr 2017 14:38:39 +0200 Err bitreich.org 70 i Err bitreich.org 70 iimprove documentation Err bitreich.org 70 i Err bitreich.org 70 i- add example to README to extract gitweb.owner from a git config. Err bitreich.org 70 i this is used in gitweb and some cgit configurations. Err bitreich.org 70 i- fix (new) mandoc warnings (new sentence on each line). Err bitreich.org 70 i- improve some texts in the man pages, sort / structure some list items. Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i M README | 19 ++++++++++++++++++- Err bitreich.org 70 i M stagit-index.1 | 13 +++++++------ Err bitreich.org 70 i M stagit.1 | 47 ++++++++++++++++++------------- Err bitreich.org 70 i Err bitreich.org 70 i3 files changed, 52 insertions(+), 27 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/README b/README /scm/stagit-gopher/file/README.gph bitreich.org 70 i@@ -61,6 +61,23 @@ make Err bitreich.org 70 i make install Err bitreich.org 70 i Err bitreich.org 70 i Err bitreich.org 70 i+Extract owner field from git config Err bitreich.org 70 i+----------------------------------- Err bitreich.org 70 i+ Err bitreich.org 70 i+A (hacky) way to extract the gitweb owner for example in the format: Err bitreich.org 70 i+ Err bitreich.org 70 i+ [gitweb] Err bitreich.org 70 i+ owner = Name here Err bitreich.org 70 i+ Err bitreich.org 70 i+Script: Err bitreich.org 70 i+ Err bitreich.org 70 i+ #!/bin/sh Err bitreich.org 70 i+ awk '/^[ ]*owner[ ]=/ { Err bitreich.org 70 i+ sub(/^[^=]*=[ ]*/, ""); Err bitreich.org 70 i+ print $0; Err bitreich.org 70 i+ }' Err bitreich.org 70 i+ Err bitreich.org 70 i+ Err bitreich.org 70 i Features Err bitreich.org 70 i -------- Err bitreich.org 70 i Err bitreich.org 70 i@@ -86,7 +103,7 @@ Cons Err bitreich.org 70 i - Not suitable for repositories with many branches, a quite linear history is Err bitreich.org 70 i assumed (from HEAD). Err bitreich.org 70 i - Relatively slow to run the first time (about 3 seconds for sbase, Err bitreich.org 70 i- 1500+ commits), incremental updates after it are faster. Err bitreich.org 70 i+ 1500+ commits), incremental updates are faster. Err bitreich.org 70 i - Does not support some of the dynamic features cgit has, like: Err bitreich.org 70 i - snapshot tarballs. Err bitreich.org 70 i - file tree per commit. Err bitreich.org 70 1diff --git a/stagit-index.1 b/stagit-index.1 /scm/stagit-gopher/file/stagit-index.1.gph bitreich.org 70 i@@ -10,13 +10,14 @@ Err bitreich.org 70 i .Sh DESCRIPTION Err bitreich.org 70 i .Nm Err bitreich.org 70 i will create an index HTML page for the repositories specified and writes Err bitreich.org 70 i-the HTML data to stdout. The repos in the index are in the same order as Err bitreich.org 70 i-the arguments Err bitreich.org 70 i+the HTML data to stdout. Err bitreich.org 70 i+The repos in the index are in the same order as the arguments Err bitreich.org 70 i .Ar repodir Err bitreich.org 70 i specified. 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+The basename of the directory is used as the repository name. Err bitreich.org 70 i+The suffix ".git" is removed from the basename, this suffix is commonly used Err bitreich.org 70 i+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 .Bl -tag -width Ds Err bitreich.org 70 i@@ -28,10 +29,10 @@ owner of repository Err bitreich.org 70 i .Pp Err bitreich.org 70 i For changing the style of the page you can use the following files: Err bitreich.org 70 i .Bl -tag -width Ds Err bitreich.org 70 i-.It logo.png Err bitreich.org 70 i-32x32 logo. Err bitreich.org 70 i .It favicon.png Err bitreich.org 70 i favicon image. Err bitreich.org 70 i+.It logo.png Err bitreich.org 70 i+32x32 logo. Err bitreich.org 70 i .It style.css Err bitreich.org 70 i CSS stylesheet. Err bitreich.org 70 i .El Err bitreich.org 70 1diff --git a/stagit.1 b/stagit.1 /scm/stagit-gopher/file/stagit.1.gph bitreich.org 70 i@@ -14,51 +14,58 @@ writes HTML pages for the repository Err bitreich.org 70 i .Ar repodir Err bitreich.org 70 i to the current directory. Err bitreich.org 70 i .Pp Err bitreich.org 70 i-Optionally the Err bitreich.org 70 i-.Fl c Ar cachefile Err bitreich.org 70 i-option can be used to cache the entries of the log page up to the point of Err bitreich.org 70 i-the last commit. The Err bitreich.org 70 i+The options are as follows: Err bitreich.org 70 i+.Bl -tag -width Ds Err bitreich.org 70 i+.It Fl c Ar cachefile Err bitreich.org 70 i+Cache the entries of the log page up to the point of Err bitreich.org 70 i+the last commit. Err bitreich.org 70 i+The Err bitreich.org 70 i .Ar cachefile 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+will store the last commit id and the entries in the HTML table. Err bitreich.org 70 i+It is up 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. Err bitreich.org 70 i+.El 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 .It atom.xml Err bitreich.org 70 i Atom XML feed Err bitreich.org 70 i .It files.html Err bitreich.org 70 i-List of files in the latest HEAD commit, linking to the file. Err bitreich.org 70 i+List of files in the latest tree, linking to the file. Err bitreich.org 70 i .It log.html Err bitreich.org 70 i List of commits in order of most recent to old of the commits (top to bottom), Err bitreich.org 70 i-each commit links to a page with a diff and diffstat of the commit. Err bitreich.org 70 i+each commit links to a page with a diffstat and diff of the commit. Err bitreich.org 70 i .It refs.html 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 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-if the data is considered to be non-textual. Err bitreich.org 70 i+file/filepath.html. Err bitreich.org 70 i+This file will contain the textual data of the file prefixed by line numbers. Err bitreich.org 70 i+The file will have the string "Binary file" if the data is considered to be Err bitreich.org 70 i+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. Too large diffs will be suppressed and a string Err bitreich.org 70 i+commit/commitid.html. Err bitreich.org 70 i+This file will contain the diffstat and diff of the commit. Err bitreich.org 70 i+It will write the string "Binary files differ" if the data is considered to Err bitreich.org 70 i+be non-textual. Err bitreich.org 70 i+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+recreate all the output files because it will contain old data. Err bitreich.org 70 i+To do this 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+The basename of the directory is used as the repository name. Err bitreich.org 70 i+The suffix ".git" is removed from the basename, this suffix is commonly used Err bitreich.org 70 i+for "bare" repos. Err bitreich.org 70 i .Pp 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@@ -75,10 +82,10 @@ exists in HEAD a direct link in the menu is made. Err bitreich.org 70 i .Pp Err bitreich.org 70 i For changing the style of the page you can use the following files: Err bitreich.org 70 i .Bl -tag -width Ds Err bitreich.org 70 i-.It logo.png Err bitreich.org 70 i-32x32 logo. Err bitreich.org 70 i .It favicon.png Err bitreich.org 70 i favicon image. Err bitreich.org 70 i+.It logo.png Err bitreich.org 70 i+32x32 logo. Err bitreich.org 70 i .It style.css Err bitreich.org 70 i CSS stylesheet. Err bitreich.org 70 i .El Err bitreich.org 70 .