Skip to content

Minor docs updates #10213

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

Merged
merged 4 commits into from
Apr 9, 2022
Merged

Minor docs updates #10213

merged 4 commits into from
Apr 9, 2022

Conversation

jsquyres
Copy link
Member

@jsquyres jsquyres commented Apr 4, 2022

Use pip's --use-feature=2020-resolver to fix a dependency problem in some environments (e.g., Fedora 33).

jsquyres added 4 commits April 7, 2022 18:55
Signed-off-by: Jeff Squyres <[email protected]>
Be foreward looking and use the "new" dependency resolver.  This also
fixes a dependency issue with docutils in some environments (e.g.,
Fedora 33).

Signed-off-by: Jeff Squyres <[email protected]>
citutor.org is now hpc-training.org.

Signed-off-by: Jeff Squyres <[email protected]>
HTML docs are installed in $(docdir)/html.

Signed-off-by: Jeff Squyres <[email protected]>
@jsquyres
Copy link
Member Author

jsquyres commented Apr 7, 2022

Once CI finishes, I'll merge so that we can rebase #10224 on top of this (because this PR now installs the HTML docs, which affects the RPM specfile).

@jsquyres
Copy link
Member Author

jsquyres commented Apr 8, 2022

bot:aws:retest

1 similar comment
@jsquyres
Copy link
Member Author

jsquyres commented Apr 8, 2022

bot:aws:retest

@jsquyres
Copy link
Member Author

jsquyres commented Apr 9, 2022

Added 2 lines to the install-data-hook rule after @bwbarrett's review (to fix the CI/distcheck breakage):

find $(DESTDIR)$(docdir) -type d -exec chmod 0755 {} \;
find $(DESTDIR)$(docdir) -type f -exec chmod 0644 {} \;
  • It is necessary to make all the installed HTML files and dirs be globally readable so that they're accessible to all users
  • It is also necessary to make them writable by the owner so that make uninstall can remove them (otherwise, make distcheck fails)
  • This behavior is consistent with what Automake's built-in install rules do (you can see them invoke /usr/bin/install -m 644 ..., for example).

@jsquyres jsquyres merged commit ee87ec3 into open-mpi:main Apr 9, 2022
@jsquyres jsquyres deleted the pr/yet-more-docs branch April 9, 2022 11:53
install-data-hook:
$(MKDIR_P) $(DESTDIR)$(docdir)
cp -r $(srcdir)/_build/html $(DESTDIR)$(docdir)
find $(DESTDIR)$(docdir) -type d -exec chmod 0755 {} \;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First, there needs to be a comment about this behavior, because the history will be lost on why we're chmodding if the only place the history exists is a comment in the PR.

Second, I don't think this is actually Automake's behavior. I agree AM installs files as 0644, but it appears that there's more logic around setting directory permissions, which I haven't entirely pulled apart.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants