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

Add some documentation for texlive #74519

Merged
merged 6 commits into from
Dec 21, 2019
Merged

Add some documentation for texlive #74519

merged 6 commits into from
Dec 21, 2019
+91 −0

Conversation

immae
Copy link
Contributor

@immae immae commented Nov 28, 2019 •
edited by veprbl
Loading

Motivation for this change

Provides documentation for adding custom packages to texlive.combine

Fixes: #17748

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 nix-review --run "nix-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.
Notify maintainers

cc @vcunat @veprbl @lovek323 @jwiegley @raskin

Sorry, something went wrong.

@immae
Add some documentation for texlive
f44e59c 
There seem to be no good way of adding a custom package to texlive.combine, this change proposes a hackish way of doing it
@immae
Copy link
Contributor Author

immae commented Nov 28, 2019

At maintainers:
This PR is also a way open a discussion about this issue, maybe I missed the "good" way of doing what I want. In any case it seem to lack documentation about how to do (good or hackish)

@tilpner
Copy link
Member

tilpner commented Nov 28, 2019

(I think @immae meant to cc @7c6f434c instead of @raskin)

@ofborg ofborg bot added 6.topic: TeX Issues regarding texlive and TeX in general 8.has: documentation This PR adds or changes documentation labels Nov 28, 2019
@immae
Copy link
Contributor Author

immae commented Nov 28, 2019

Oups sorry, I thought there were a correspondance between the name in the meta.maintainers and the github id

@immae
Copy link
Contributor Author

immae commented Nov 28, 2019

2019-11-28_19_50_55

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux labels Nov 28, 2019
veprbl
veprbl reviewed Nov 30, 2019
View reviewed changes
@veprbl
Copy link
Member

veprbl commented Nov 30, 2019

Related to #17748

immae and others added 3 commits December 7, 2019 12:30
@immae
Update texlive.xml
07c0489
@veprbl
Reword, add concrete example

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
805c425
@veprbl
s/a/the/
93a1cf2
@veprbl
Copy link
Member

veprbl commented Dec 21, 2019

I've updated the PR. Wording was adjusted to be more neutral. By that I mean that we don't need to provide reader with our opinion on the interface texlive.combine, those are not that informative, and, I believe, we can safely assume that our users are perfectly capable of making their own mind about things. I also provide an example of using a specific package. I chose it mostly because it's the only external package that I am familiar with.

@immae
Copy link
Contributor Author

immae commented Dec 21, 2019

Again, I don’t see how I expressed any opinion about the interface, but English is not my mother language so maybe I miss some subtelties. Thanks for the update!

@veprbl
Don't generate docs (this goes into the tlType="doc" and we don't ins…

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
21cea5a 
…tall those by default)
@veprbl
split long line

Verified

This commit was signed with the committer’s verified signature.
veprbl Dmitry Kalinkin
GPG key ID: 5157B3EC8B2CA333
Verified
Learn about vigilant mode
fcc3258
@veprbl veprbl merged commit b42bede into NixOS:master Dec 21, 2019
@veprbl
Copy link
Member

veprbl commented Dec 21, 2019

@immae Thank you for addressing this!

@Janik-Haag Janik-Haag added the 12. first-time contribution This PR is the author's first one; please be gentle! label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@veprbl veprbl

Assignees
No one assigned
Labels
6.topic: TeX Issues regarding texlive and TeX in general 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

texlive.combine: use your own packages
4 participants
@immae @tilpner @veprbl @Janik-Haag