Skip to content

/zcash

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve autogenerated manpages #2124

Merged
merged 12 commits into from Mar 2, 2017

Conversation

@str4d
Copy link
Contributor

str4d commented Feb 23, 2017

Cherry-picked from bitcoin/bitcoin#8608.

Closes #2086.
nomnombtc added 5 commits Aug 26, 2016
@nomnombtc @str4d
add script to generate manpages with help2man
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
95d9334
@nomnombtc @str4d
add gen-manpages.sh description to README.md
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
0745198
@nomnombtc @str4d
add autogenerated manpages by help2man
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
561e46a
@nomnombtc @str4d
add doc/man/Makefile.am to include manpages
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
12a3f32
@nomnombtc @str4d
add doc/man to subdir if configure flag --enable-man is set
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
7a8eda9
@str4d str4d modified the milestone: 1.0.7 Feb 23, 2017
@daira
daira approved these changes Feb 23, 2017
View changes
Copy link
Contributor

daira left a comment

utACK.
@daira
daira approved these changes Feb 28, 2017
View changes
@arcalinea

This comment has been minimized.

Sign in to view
Copy link
Contributor

arcalinea commented Mar 2, 2017 •
edited

This script successfully generates man pages.

Help2man doesn't recognize "Commands" and "Register Commands" as distinct sections that should be bolded though. This is the same for the upstream autogenerated man pages as well. Maybe this is worth changing the formatting for later.

Screenshot of what I mean:
zcashtx-man

ACK on this for now, though
@daira

This comment has been minimized.

Sign in to view
Copy link
Contributor

daira commented Mar 2, 2017

Comments are non-blocking. @zkbot r+
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

📌 Commit cc39080 has been approved by daira
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

⌛️ Testing commit cc39080 with merge ff9b21e...
zkbot added a commit that referenced this pull request Mar 2, 2017
@zkbot
Auto merge of #2124 - str4d:2086-help2man, r=daira
ff9b21e 
Improve autogenerated manpages

Cherry-picked from bitcoin/bitcoin#8608.

Closes #2086.
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

💔 Test failed - zcash
@arcalinea
arcalinea reviewed Mar 2, 2017
View changes
configure.ac Outdated
@@ -976,6 +982,7 @@ AC_SUBST(GMPXX_LIBS)
AC_SUBST(LIBSNARK_LIBS)
AC_SUBST(LIBZCASH_LIBS)
AC_CONFIG_FILES([Makefile src/Makefile share/setup.nsi share/qt/Info.plist src/test/buildenv.py])
AC_CONFIG_FILES([Makefile src/Makefile doc/man/Makefile share/setup.nsi share/qt/Info.plist src/test/buildenv.py])

This comment has been minimized.

Sign in to view
Copy link
@arcalinea

arcalinea Mar 2, 2017 •
edited

Contributor

Was this duplicated in merge? Think registering src/Makefile twice is causing build.sh to fail

This comment has been minimized.

Sign in to view
Copy link
@str4d

str4d Mar 2, 2017

Author Contributor

This should have been a change, not an addition (there was a merge conflict).
@arcalinea

This comment has been minimized.

Sign in to view
Copy link
Contributor

arcalinea commented Mar 2, 2017 •
edited

Build.sh failed locally for me with the same error as it did on the test server,

+ ./autogen.sh
configure.ac:985: error: `Makefile' is already registered with AC_CONFIG_FILES.
../../lib/autoconf/status.m4:288: AC_CONFIG_FILES is expanded from...
configure.ac:985: the top level
autom4te: /usr/bin/m4 failed with exit status: 1
aclocal: error: echo failed with exit status: 1
autoreconf: aclocal failed with exit status: 1

See comment on configure.ac line 985 -- possible merge conflict when this was pulled in?
....
Using zkbot to run tests on the fix I applied below that let me build it successfully locally
@arcalinea

This comment has been minimized.

Sign in to view
Copy link
Contributor

arcalinea commented Mar 2, 2017

@zkbot try
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

⌛️ Trying commit fc82d19 with merge 8ef121e...
zkbot added a commit that referenced this pull request Mar 2, 2017
@zkbot
Auto merge of #2124 - str4d:2086-help2man, r=<try>
8ef121e 
Improve autogenerated manpages

Cherry-picked from bitcoin/bitcoin#8608.

Closes #2086.
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

☀️ Test successful - zcash
@str4d

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

str4d commented Mar 2, 2017

@arcalinea thanks for catching that. I'll rebase to merge your change into the original commit, so the cherry-picked commit matches bitcoin/bitcoin@a32c102 upstream.
nomnombtc added 4 commits Aug 26, 2016
@nomnombtc @str4d
add conditional for --enable-man, default is yes
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
abfcaef
@nomnombtc @str4d
change help string --enable-man to --disable-man
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
1b5e712
@nomnombtc @str4d
regenerated all manpages with commit tag stripped, also add bitcoin-tx
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
4a558b2
@nomnombtc @str4d
improved gen-manpages.sh, includes bitcoin-tx and strips commit tag, …
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
0764066 
…now also runs binaries from build dir by default, added variables for more control
str4d added 3 commits Feb 23, 2017
@str4d
Adjust gen-manpages.sh for Zcash, use in Debian builds
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
a0e6d5a
@str4d
Regenerate and collate Zcash manpages, delete Bitcoin ones
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
1f5cc3f
@str4d
Update release process with gen-manpages.sh
Verified
This commit was signed with a verified signature.
str4d
GPG key ID: 6A6914DAFBEA00DA Learn about signing commits
Loading status checks…
6337870
@str4d str4d force-pushed the str4d:2086-help2man branch from fc82d19 to 6337870 Mar 2, 2017
@str4d

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

str4d commented Mar 2, 2017

Done.

@zkbot r+
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

📌 Commit 6337870 has been approved by str4d
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

⌛️ Testing commit 6337870 with merge b75b2de...
zkbot added a commit that referenced this pull request Mar 2, 2017
@zkbot
Auto merge of #2124 - str4d:2086-help2man, r=str4d
b75b2de 
Improve autogenerated manpages

Cherry-picked from bitcoin/bitcoin#8608.

Closes #2086.
@zkbot

This comment has been minimized.

Sign in to view
Copy link
Collaborator

zkbot commented Mar 2, 2017

☀️ Test successful - zcash
@zkbot zkbot merged commit 6337870 into zcash:master Mar 2, 2017
1 check passed
1 check passed
homu Test successful
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arcalinea arcalinea

@daira daira

Assignees
No one assigned
Labels
dev infrastructure documentation release review needed
Projects
None yet
Milestone
  1.0.7
5 participants
@str4d @arcalinea @daira @zkbot @nomnombtc
You can’t perform that action at this time.