put version in man pages, update man page dates, fix version mention (#545)

* put version in man pages and fix version mention * update dates in man pages
5 years ago · 8b9feaa662
parent c1ac63a60e
commit 8b9feaa662
17 changed files with 30 additions and 27 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -2,13 +2,18 @@

 ## {{Next Version}}

+### Bugfixes
+
+- Fix mention of version in git-secret add man page (#544)
+
 ### Misc

 - Update developer docs, especially regarding mac, docker, and test-kitchen (#195)
+- Update man pages to mention version documented (#420)

 ## Version 0.3.1

-## Misc
+### Misc

 - Update man pages

@ -29,7 +34,7 @@
 - Handle case of key having no email and a comment (#527)
 - Avoid blank lines from output of 'clean -v'

-## Misc
+### Misc

 - Improve messaging and logic around deleting tmp files.
 - Add note about secrets and old keys (#499)
@ -78,7 +83,7 @@
 - Respect DESTDIR when installing as per GNU/debian/etc recommendations (#424)
 - Use git check-ignore to test for files ignored by git

-## Misc
+### Misc

 - Improve docs about hide -m option (#467)
 - Document SECRETS_VERBOSE and improve env var docs (#396)
@ -118,7 +123,7 @@
 - Require keys to be specified by email, as documented (#267)
 - Disallow 'git secret tell' or 'killperson' with emails that are not in keychain (also #267)

-## Misc
+### Misc

 - Added notes about packages and for package maintainers (#281)
 - Improve documentation regarding operation with different versions of GPG (#274, #182)
--- a/5
+++ b/5
@ -57,8 +57,9 @@ clean-man:
 	find "man/" -type f ! -name "*.ronn" -delete

 .PHONY: build-man
-build-man: install-ronn clean-man
-	ronn --roff --organization="sobolevn" --manual="git-secret" man/*/*.ronn
+build-man: install-ronn clean-man git-secret
+	touch man/*/*.ronn
+	export GITSECRET_VERSION=`./git-secret --version` && ronn --roff --organization="sobolevn" --manual="git-secret $${GITSECRET_VERSION}" man/*/*.ronn

 .PHONY: build-gh-pages
 build-gh-pages:
--- a/man/man1/git-secret-add.1
+++ b/man/man1/git-secret-add.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-ADD" "1" "September 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-ADD" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-add\fR \- starts to track added files\.
@ -18,16 +18,13 @@ git secret add [\-i] <pathspec>\.\.\.
 \fBgit\-secret\-add\fR adds a filepath(s) into \fB\.gitsecret/paths/mapping\.cfg\fR and ensures the filepath is mentioned \.gitignore\.
 .
 .P
-When adding files to encrypt, \fBgit\-secret\-add\fR (as of 0\.3\.0) will ensure that they are ignored by \fBgit\fR by mentioning them in \.gitignore, since they must be secure and not be committed into the remote repository unencrypted\.
+When adding files to encrypt, \fBgit\-secret\-add\fR (as of 0\.2\.6) will ensure that they are ignored by \fBgit\fR by mentioning them in \.gitignore, since they must be secure and not be committed into the remote repository unencrypted\.
 .
 .P
 If there\'s no users in the \fBgit\-secret\fR\'s keyring, when adding a file, an exception will be raised\.
 .
 .P
-Use the \fBgit secret add\fR command to add filenames to this file\.
-.
-.br
-It is not recommended to add filenames directly into \fB\.gitsecret/paths/mapping\.cfg\fR\.
+Use the \fBgit secret add\fR command to add filenames to this file\. It is not recommended to add filenames directly into \fB\.gitsecret/paths/mapping\.cfg\fR\.
 .
 .P
 (See git\-secret(7) \fIhttp://git\-secret\.io/git\-secret\fR for information about renaming the \.gitsecret folder using the SECRETS_DIR environment variable\.
--- a/man/man1/git-secret-add.1.ronn
+++ b/man/man1/git-secret-add.1.ronn
@ -10,12 +10,12 @@ git-secret-add - starts to track added files.
 `git-secret-add` adds a filepath(s) into `.gitsecret/paths/mapping.cfg`
 and ensures the filepath is mentioned .gitignore.

-When adding files to encrypt, `git-secret-add` (as of 0.3.0) will ensure that they are ignored by `git` by mentioning 
+When adding files to encrypt, `git-secret-add` (as of 0.2.6) will ensure that they are ignored by `git` by mentioning
 them in .gitignore, since they must be secure and not be committed into the remote repository unencrypted.

 If there's no users in the `git-secret`'s keyring, when adding a file, an exception will be raised.

-Use the `git secret add` command to add filenames to this file.  
+Use the `git secret add` command to add filenames to this file.
 It is not recommended to add filenames directly into `.gitsecret/paths/mapping.cfg`.

 (See [git-secret(7)](http://git-secret.io/git-secret) for information about renaming the .gitsecret
--- a/man/man1/git-secret-cat.1
+++ b/man/man1/git-secret-cat.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-CAT" "1" "September 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-CAT" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout
--- a/man/man1/git-secret-changes.1
+++ b/man/man1/git-secret-changes.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-CHANGES" "1" "September 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-CHANGES" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-changes\fR \- view diff of the hidden files\.
--- a/man/man1/git-secret-clean.1
+++ b/man/man1/git-secret-clean.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-CLEAN" "1" "September 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-CLEAN" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-clean\fR \- removes all the hidden files\.
--- a/man/man1/git-secret-hide.1
+++ b/man/man1/git-secret-hide.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-HIDE" "1" "September 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-HIDE" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\.
--- a/man/man1/git-secret-init.1
+++ b/man/man1/git-secret-init.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-INIT" "1" "July 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-INIT" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-init\fR \- initializes git\-secret repository\.
--- a/man/man1/git-secret-killperson.1
+++ b/man/man1/git-secret-killperson.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-KILLPERSON" "1" "July 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-KILLPERSON" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-killperson\fR \- deletes key identified by an email from the inner keyring\.
--- a/man/man1/git-secret-list.1
+++ b/man/man1/git-secret-list.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-LIST" "1" "July 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-LIST" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-list\fR \- prints all the added files\.
--- a/man/man1/git-secret-remove.1
+++ b/man/man1/git-secret-remove.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-REMOVE" "1" "July 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-REMOVE" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-remove\fR \- removes files from index\.
--- a/man/man1/git-secret-reveal.1
+++ b/man/man1/git-secret-reveal.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-REVEAL" "1" "September 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-REVEAL" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-reveal\fR \- decrypts all added files\.
--- a/man/man1/git-secret-tell.1
+++ b/man/man1/git-secret-tell.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-TELL" "1" "July 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-TELL" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-tell\fR \- adds a person, who can access private data\.
--- a/man/man1/git-secret-usage.1
+++ b/man/man1/git-secret-usage.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-USAGE" "1" "July 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-USAGE" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-usage\fR \- prints all the available commands\.
--- a/man/man1/git-secret-whoknows.1
+++ b/man/man1/git-secret-whoknows.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET\-WHOKNOWS" "1" "July 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-WHOKNOWS" "1" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\-whoknows\fR \- prints email\-labels for each key in the keyring\.
--- a/man/man7/git-secret.7
+++ b/man/man7/git-secret.7
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-SECRET" "7" "September 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET" "7" "September 2019" "sobolevn" "git-secret 0.3.1"
 .
 .SH "NAME"
 \fBgit\-secret\fR \- bash tool to store private data inside a git repo\.