Skip to content
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.

Sign up for GitHub

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

Jump to bottom

man_make_section_directory should not be enabled by default #9217

Closed
foutrelis opened this issue May 12, 2021 · 1 comment
Closed

man_make_section_directory should not be enabled by default #9217

foutrelis opened this issue May 12, 2021 · 1 comment
Labels
builder:manpage type:bug
Milestone
4.1.0

Comments

@foutrelis
Copy link

foutrelis commented May 12, 2021 •
edited

Enabling man_make_section_directory by default in #8284 breaks projects relying on the previous behavior. This is a serious problem for Linux distributions that will end up with misplaced and unusable man pages. Please consider keeping it disabled by default; the benefit of being able to use MANPATH in the output directory does not justify this kind of breakage.

I also noticed that the current implementation generates paths like <builddir>/1 instead of <builddir>/man1. Only the latter can be used with MANPATH which appears to be the main motivation behind #7996.

Examples of breakage I've seen so far (and we've only had sphinx 4.0.x in Arch Linux for three days):

fish-shell does not expect the section subdirectory and results in man pages for built-in shell commands being installed to usr/share/fish/man/man1/1 instead of usr/share/fish/man/man1 and also fails to filter out fish.1, fish_indent.1 and fish_key_reader.1 which are meant to be installed to usr/share/man/man1.

llvm-project copies the output directory to usr/share/man/man1 resulting in paths like usr/share/man/man1/1/foo.1 (note the additional 1 directory).
tk0miya added a commit to tk0miya/sphinx that referenced this issue May 15, 2021
@tk0miya
Fix sphinx-doc#9217: manpage: Dirname of man_make_section_directory i…
a6f9e5a 
…s wrong

* Correct: man/man1
* Wrong:   man/1
@tk0miya tk0miya mentioned this issue May 15, 2021
Merged
@tk0miya tk0miya added this to the 4.0.2 milestone May 15, 2021
@tk0miya tk0miya mentioned this issue May 15, 2021
Merged
@tk0miya tk0miya modified the milestones: 4.0.2, 4.1.0 May 16, 2021
@tk0miya
Copy link
Member

tk0miya commented May 16, 2021

Thank you for letting us know. I just reverted the change of default setting in #9232. It will be released as 4.0.2 soon. And I'll change the directory name in #9231. It will be released as 4.1.0.

tk0miya added a commit that referenced this issue May 19, 2021
@tk0miya
Merge pull request #9231 from tk0miya/9217_manpage_section_directory
567ff22 
Fix #9217: manpage: Dirname of man_make_section_directory is wrong
@markmentovai markmentovai mentioned this issue May 21, 2021
Closed
11 tasks
markmentovai added a commit to markmentovai/macports-ports that referenced this issue May 21, 2021
@markmentovai
py-sphinx: update to 4.0.2 (2021-05-20)
97836b9 
This is necessary to pick up upstream 567ff22716ac (2021-05-19),
sphinx-doc/sphinx#9231, fixing
sphinx-doc/sphinx#9217 introduced in 4.0. This
corrects a backwards-incompatible change in py-sphinx that prevented
dependent ports such as cmake and mame from being able to build.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
builder:manpage type:bug
Projects
None yet
Milestone
4.1.0
Development

No branches or pull requests
2 participants
@foutrelis @tk0miya