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.

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

git: Use asciidoctor instead of asciidoc for manpages #102020

Merged
merged 1 commit into from Oct 30, 2020

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.

@SuperSandro2000
Copy link
Member

@SuperSandro2000 SuperSandro2000 commented Oct 29, 2020

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

@jonringer jonringer commented Oct 29, 2020

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

Copy link
Member

@primeos primeos left a comment

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.

Asciidoc is severely outdated and is replaced by asciidoctor.
Eliminating asciidoc gets rid of a python2 dependency, see
#101964
@primeos primeos force-pushed the braunse:use-asciidoctor-for-git-docs branch from ac083f9 to bbf96d8 Oct 30, 2020
@ofborg ofborg bot requested a review from primeos Oct 30, 2020
@primeos
Copy link
Member

@primeos primeos commented Oct 30, 2020

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
19 checks passed
19 checks passed
@github-actions
tests
Details
@github-actions
action
Details
@ofborg
Evaluation Performance Report Evaluator Performance Report
Details
@github-actions
Wait for ofborg
Details
@ofborg
git, git.passthru.tests on aarch64-linux Success
Details
@ofborg
git, git.passthru.tests on x86_64-linux Success
Details
@ofborg
grahamcofborg-eval ^.^!
Details
@ofborg
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
@ofborg
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
@ofborg
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="bbf96d8"; rev="bbf96d898b96ea2d1ff19a09e545499e4f32d8d0"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-lib-tests nix-build --arg pkgs import ./. {} ./lib/tests/release.nix
Details
@ofborg
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="bbf96d8"; rev="bbf96d898b96ea2d1ff19a09e545499e4f32d8d0"; } ./nixos/
Details
@ofborg
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="bbf96d8"; rev="bbf96d898b96ea2d1ff19a09e545499e4f32d8d0"; } ./nixos/
Details
@ofborg
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="bbf96d8"; rev="bbf96d898b96ea2d1ff19a09e545499e4f32d8d0"; } ./nixos/
Details
@ofborg
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="bbf96d8"; rev="bbf96d898b96ea2d1ff19a09e545499e4f32d8d0"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="bbf96d8"; rev="bbf96d898b96ea2d1ff19a09e545499e4f32d8d0"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="bbf96d8"; rev="bbf96d898b96ea2d1ff19a09e545499e4f32d8d0"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
@ofborg
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
raboof added a commit to raboof/nixpkgs that referenced this pull request Nov 30, 2020
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.
@raboof raboof mentioned this pull request Nov 30, 2020
1 of 10 tasks
raboof added a commit to raboof/nixpkgs that referenced this pull request Dec 1, 2020
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
4 of 10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants