Rewrite the manual page generation script in Python.
This:
Also change the release process to swap gen-manpages and update RC steps, so that the pages will have the correct rc and/or final version.
Does anyone understand this mypy output?
contrib/devtools/gen-manpages.py:26: error: No overload variant of "run" matches argument types "List[str]", "bool", "bool", "bool" [call-overload]
contrib/devtools/gen-manpages.py:26: note: Possible overload variants:
contrib/devtools/gen-manpages.py:26: note: def run(args: Union[Union[bytes, str], Sequence[Union[str, bytes, PathLike[str], PathLike[bytes]]]], bufsize: int = ..., executable: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., stdin: Union[None, int, IO[Any]] = ..., stdout: Union[None, int, IO[Any]] = ..., stderr: Union[None, int, IO[Any]] = ..., preexec_fn: Optional[Callable[[], Any]] = ..., close_fds: bool = ..., shell: bool = ..., cwd: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., env: Union[Mapping[bytes, Union[str, bytes, PathLike[str], PathLike[bytes]]], Mapping[str, Union[str, bytes, PathLike[str], PathLike[bytes]]], None] = ..., universal_newlines: bool = ..., startupinfo: Any = ..., creationflags: int = ..., restore_signals: bool = ..., start_new_session: bool = ..., pass_fds: Any = ..., *, check: bool = ..., encoding: str, errors: Optional[str] = ..., input: Optional[str] = ..., timeout: Optional[float] = ...) -> CompletedProcess[str]
contrib/devtools/gen-manpages.py:26: note: def run(args: Union[Union[bytes, str], Sequence[Union[str, bytes, PathLike[str], PathLike[bytes]]]], bufsize: int = ..., executable: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., stdin: Union[None, int, IO[Any]] = ..., stdout: Union[None, int, IO[Any]] = ..., stderr: Union[None, int, IO[Any]] = ..., preexec_fn: Optional[Callable[[], Any]] = ..., close_fds: bool = ..., shell: bool = ..., cwd: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., env: Union[Mapping[bytes, Union[str, bytes, PathLike[str], PathLike[bytes]]], Mapping[str, Union[str, bytes, PathLike[str], PathLike[bytes]]], None] = ..., universal_newlines: bool = ..., startupinfo: Any = ..., creationflags: int = ..., restore_signals: bool = ..., start_new_session: bool = ..., pass_fds: Any = ..., *, check: bool = ..., encoding: Optional[str] = ..., errors: str, input: Optional[str] = ..., timeout: Optional[float] = ...) -> CompletedProcess[str]
contrib/devtools/gen-manpages.py:26: note: <3 more similar overloads not shown, out of 5 total overloads>
contrib/devtools/gen-manpages.py:31: error: Argument 1 to "join" has incompatible type "Optional[str]"; expected "Union[str, PathLike[str]]" [arg-type]
contrib/devtools/gen-manpages.py:38: error: Argument 1 to "join" has incompatible type "Optional[str]"; expected "Union[str, PathLike[str]]" [arg-type]
contrib/devtools/gen-manpages.py:40: error: No overload variant of "run" matches argument types "List[str]", "bool", "bool" [call-overload]
contrib/devtools/gen-manpages.py:40: note: Possible overload variants:
contrib/devtools/gen-manpages.py:40: note: def run(args: Union[Union[bytes, str], Sequence[Union[str, bytes, PathLike[str], PathLike[bytes]]]], bufsize: int = ..., executable: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., stdin: Union[None, int, IO[Any]] = ..., stdout: Union[None, int, IO[Any]] = ..., stderr: Union[None, int, IO[Any]] = ..., preexec_fn: Optional[Callable[[], Any]] = ..., close_fds: bool = ..., shell: bool = ..., cwd: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., env: Union[Mapping[bytes, Union[str, bytes, PathLike[str], PathLike[bytes]]], Mapping[str, Union[str, bytes, PathLike[str], PathLike[bytes]]], None] = ..., universal_newlines: bool = ..., startupinfo: Any = ..., creationflags: int = ..., restore_signals: bool = ..., start_new_session: bool = ..., pass_fds: Any = ..., *, check: bool = ..., encoding: str, errors: Optional[str] = ..., input: Optional[str] = ..., timeout: Optional[float] = ...) -> CompletedProcess[str]
contrib/devtools/gen-manpages.py:40: note: def run(args: Union[Union[bytes, str], Sequence[Union[str, bytes, PathLike[str], PathLike[bytes]]]], bufsize: int = ..., executable: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., stdin: Union[None, int, IO[Any]] = ..., stdout: Union[None, int, IO[Any]] = ..., stderr: Union[None, int, IO[Any]] = ..., preexec_fn: Optional[Callable[[], Any]] = ..., close_fds: bool = ..., shell: bool = ..., cwd: Union[str, bytes, PathLike[str], PathLike[bytes], None] = ..., env: Union[Mapping[bytes, Union[str, bytes, PathLike[str], PathLike[bytes]]], Mapping[str, Union[str, bytes, PathLike[str], PathLike[bytes]]], None] = ..., universal_newlines: bool = ..., startupinfo: Any = ..., creationflags: int = ..., restore_signals: bool = ..., start_new_session: bool = ..., pass_fds: Any = ..., *, check: bool = ..., encoding: Optional[str] = ..., errors: str, input: Optional[str] = ..., timeout: Optional[float] = ...) -> CompletedProcess[str]
contrib/devtools/gen-manpages.py:40: note: <3 more similar overloads not shown, out of 5 total overloads>
I can't reproduce it locally with mypy 0.761 and python 3.8.10. I don't think I'm passing anything weird to subprocess.run or path.join.
Edit: also tried with mypy 0.931. No dice.
Edit.2: FIgured it out, I think. capture_output is new in Python 3.7 so too recent.
Rewrite the manual page generation script in Python.
This:
- Solves '-' stripping issue (fixes #22681)
- Makes that copyright footer is generated again
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--174a7506f384e20aa4161008e828411d-->
Reviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
Concept ACK
Something that is weird, but outside scope of this particular PR to fix. is that the copyright message is emitted inconsistently between binaries:
| binary | -help | -version |
|---|---|---|
| bitcoind | yes | no |
| bitcoin-cli | no | no |
| bitcoin-tx | no | no |
| bitcoin-wallet | no | no |
| bitcoin-util | no | no |
| bitcoin-qt | no | yes |
I don't have a strong opinion on whether it should be shown with -version or -help, but it probably should be either, and consistent between binaries.
@dongcarl Can I get a concept ACK here at least? It should exactly do what you propose in #22681 (comment)
40 | + r = subprocess.run([abspath, '--version'], stdout=subprocess.PIPE, universal_newlines=True) 41 | + except IOError: 42 | + print(f'{abspath} not found or not an executable', file=sys.stderr) 43 | + sys.exit(1) 44 | + # take first line (which must contain version) 45 | + verstr = r.stdout.split('\n')[0]
Nit
verstr = r.stdout.splitlines()[0]
35 | +copyright = None 36 | +versions = [] 37 | +for relpath in BINARIES: 38 | + abspath = os.path.join(builddir, relpath) 39 | + try: 40 | + r = subprocess.run([abspath, '--version'], stdout=subprocess.PIPE, universal_newlines=True)
Any reason not to do check=True here?
The script will fail because bitcoin-wallet returns non-0.
Code Review ACK 87f54060ffffdb56c97594efdca378bace5323df
Had to remind myself of the situation but everything looks good, just a few nits that are 100% ignore-able.
Concept ACK
Concept ACK
ACK 87f54060ffffdb56c97594efdca378bace5323df - tested generating and opening the man pages locally, but didn't run through the release process. Will propose some changes to address consolidating the help / version output.
Milestone
23.0