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

git: Use asciidoctor instead of asciidoc for manpages #102020

Merged
merged 1 commit into from
Oct 30, 2020
Merged

git: Use asciidoctor instead of asciidoc for manpages #102020

merged 1 commit into from
Oct 30, 2020
+5 −5

Conversation

braunse
Copy link
Contributor

@braunse braunse commented Oct 29, 2020

Motivation for this change

Asciidoc is severely outdated and is replaced by asciidoctor, according to https://github.com/asciidoc/asciidoc
Eliminating asciidoc gets rid of a python2 dependency, see #101964.

This change should only affect documentation, but triggers rebuilds of 2498 packages.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Closure size slightly increased:

/nix/store/zz276mn9d0z2zy945a4155ysgxr46zn6-git-2.29.1 376934920 # with asciidoc
/nix/store/msgklz0qd10q67h9166ksa9f7fz324y6-git-2.29.1 379787920 # with asciidoctor

The size changes are mainly due to larger HTML output.

Sorry, something went wrong.

@braunse braunse force-pushed the use-asciidoctor-for-git-docs branch from a864ed7 to ac083f9 Compare October 29, 2020 11:04
@ofborg ofborg bot requested review from globin, primeos, wmertens and peti October 29, 2020 11:15
@SuperSandro2000 SuperSandro2000 mentioned this pull request Oct 29, 2020
Merged
10 tasks
@SuperSandro2000
Copy link
Member

When building this PR on darwin it fails because pango fails to build. I created #102059 to fix this which should be merged before or along with this PR or we break a lot for darwin.

@jonringer
Copy link
Contributor

I'm not sure why, but one of the arch tests now fail

primeos
primeos approved these changes Oct 30, 2020
View reviewed changes
Copy link
Member

@primeos primeos left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I've tested this yesterday and everything still seemed fine. With the other PR merged this should be good to go now.

I'm not sure why, but one of the arch tests now fail

IIRC that test can be flaky on AArch64, I'll try to restart the build.
If that's a problem on Hydra as well we also might want to disable that test on AArch64.

Edit:
On Hydra it seems fine: https://hydra.nixos.org/job/nixpkgs/trunk/git.aarch64-linux/all
I guess it only happens with @GrahamcOfBorg, became flaky in 2.29, or this PR has indeed some very strange effect on the tests that only breaks AArch64.

@braunse @primeos
git: Use asciidoctor instead of asciidoc for manpages

Verified

This commit was signed with the committer’s verified signature.
ljharb Jordan Harband
GPG key ID: 9F6A681E35EF8B56
Verified
Learn about vigilant mode
bbf96d8 
Asciidoc is severely outdated and is replaced by asciidoctor.
Eliminating asciidoc gets rid of a python2 dependency, see
NixOS#101964
@primeos primeos force-pushed the use-asciidoctor-for-git-docs branch from ac083f9 to bbf96d8 Compare October 30, 2020 09:49
@ofborg ofborg bot requested a review from primeos October 30, 2020 10:01
@primeos
Copy link
Member

primeos commented Oct 30, 2020 •
edited
Loading

Ok, the test passes now. I'll try to keep an eye on it when checking future PRs.

Edit: And thanks for the PR! As a side-effect this also improved the formatting of the man pages a bit (e.g. ISO dates and right-justified numbers for enumerations).

@primeos primeos merged commit 54ff028 into NixOS:staging Oct 30, 2020
@raboof raboof mentioned this pull request Nov 30, 2020
Merged
10 tasks
raboof added a commit to raboof/nixpkgs that referenced this pull request Dec 1, 2020
@raboof @veprbl
git: make manual reproducible
91099b0 
This makes the git HTML manual reproducible.

It also removes the `git.info` manual, since this one is
basically entirely broken anyway. This likely happened
when we migrated from asciidoc to asciidoctor in NixOS#102020.
I don't suggest going back to asciidoc: that would
re-introduce a python2 dependency and another
reproducibility issue with the HTML docs.

Co-Authored-By: Dmitry Kalinkin <dmitry.kalinkin@gmail.com>
@primeos primeos mentioned this pull request May 18, 2021
Merged
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonringer jonringer

@globin globin

@wmertens wmertens

@peti peti

@primeos primeos

Assignees
No one assigned
Labels
10.rebuild-darwin: 501+ 10.rebuild-darwin: 1001-2500 10.rebuild-linux: 501+ 10.rebuild-linux: 2501-5000
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@braunse @SuperSandro2000 @jonringer @primeos