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

Jump to bottom

openssl_1_1: Add "doc" output to contain HTML documentation #51776

Closed
wants to merge 1 commit into from
Closed

openssl_1_1: Add "doc" output to contain HTML documentation #51776

wants to merge 1 commit into from

Conversation

andrew-d
Copy link
Contributor

@andrew-d andrew-d commented Dec 9, 2018

Motivation for this change

This prevents cluttering up openssl_1_1.out with many megabytes of
documentation.

Fixes #51659

nix path-info -S on all outputs (removes ~4MiB):

/nix/store/b0grh9y7jha1bqylys19nhlhgla5c0li-openssl-1.1.1a      	   33366856
/nix/store/ayag935jq2v3f815l71axzixgki36q9s-openssl-1.1.1a-bin  	   99291400
/nix/store/wxzrd0k1y040hkgjcya4s3w59skdd46q-openssl-1.1.1a-debug	  178042592
/nix/store/7r9cmd94zybr6c4d2wyv1j2mkv15mkqc-openssl-1.1.1a-dev  	  100675240
/nix/store/f2v9hm0n6a7yqsim2z84515vsrbk36g0-openssl-1.1.1a-man  	    2991344

/nix/store/hmdb0z6428q3x816c4zcgxkfbl9qmgl0-openssl-1.1.1a      	   29183200
/nix/store/scln0ian29fiph1f31cagzg1j67r8dgm-openssl-1.1.1a-bin  	   95107744
/nix/store/5gkvli9rj2ki07m5bywyksmqdhgc52m8-openssl-1.1.1a-debug	  178042592
/nix/store/z8j2k6anpa7hhw14wx9kvc0if2bzd8wr-openssl-1.1.1a-dev  	   96491584
/nix/store/wjw5mfwzcsfrpkhixc9ghcjsh3rcfz41-openssl-1.1.1a-man  	    2991344
/nix/store/qxsdprn78ci05m386xk320zbblf4kf5v-openssl-1.1.1a-doc  	    4183752
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • 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 nox --run "nox-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)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

cc @joachifm

@andrew-d
openssl_1_1: Add "doc" output to contain HTML documentation
e2eb4dd 
This prevents cluttering up openssl_1_1.out with many megabytes of
documentation.

Fixes NixOS#51659
@joachifm
Copy link
Contributor

joachifm commented Dec 9, 2018

@GrahamcOfBorg build openssl_1_1

@Mic92
Copy link
Member

Mic92 commented Dec 9, 2018

Does this need to be conditional? We could add the doc output even unconditional.

@andrew-d
Copy link
Contributor Author

andrew-d commented Dec 9, 2018 via email

vcunat
vcunat approved these changes Dec 9, 2018
View reviewed changes
Copy link
Member

@vcunat vcunat left a comment

Choose a reason for hiding this comment

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

Seems nice to me.

@vcunat
Copy link
Member

vcunat commented Dec 9, 2018 •
edited

Looking at Borg's checks, this could go to master directly, just note the nitpick: we'd need to "rebase", i.e. remove the other staging commits that aren't in master yet.

@Mic92 Mic92 mentioned this pull request Dec 9, 2018
Merged
10 tasks
@Mic92
Copy link
Member

Mic92 commented Dec 9, 2018

Here is the rebase: #51781

@vcunat vcunat closed this Dec 9, 2018
@andrew-d andrew-d deleted the andrew/openssl-11-docs branch December 9, 2018 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vcunat vcunat vcunat approved these changes

Assignees
No one assigned
Labels
10.rebuild-darwin: 11-100 10.rebuild-linux: 11-100
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@andrew-d @joachifm @Mic92 @vcunat @GrahamcOfBorg