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

doc: update lua documentation #55302

Merged
merged 5 commits into from Jun 9, 2020
Merged

doc: update lua documentation #55302

merged 5 commits into from Jun 9, 2020

Conversation

@teto
Copy link
Contributor

@teto teto commented Feb 6, 2019

Reflects the recent changes to the lua infrastructure.
Packaging from luarocks should be encouraged.
At first I intended to discard the buildLuaPackage completely (rather alias it to buildLuaRocks) but I guess it makes sense to keep both so I need to update the documentation regarding that.

I believe it might be best to wait a bit to see how the lua infrastructure evolves but I am looking for advice on the documentation (both technical and outline).

I couldn't build it on master:

	--out-link ./functions/library/locations.xml
trace: `mkStrict' is obsolete; use `mkOverride 0' instead.
trace: `lib.nixpkgsVersion` is deprecated, use `lib.version` instead!
trace: Warning: `showVal` is deprecated and will be removed in the next release, please use `traceSeqN`
trace: lib.zip is deprecated, use lib.zipAttrsWith instead
/nix/store/x0r93nfw3n7lnb9hpc5xp47qyvr8lgrz-locations.xml
xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
warning: failed to load external entity "functions/library/generated/strings.xml"
functions/library.xml:19: element include: XInclude error : could not load functions/library/generated/strings.xml, and no fallback was found
warning: failed to load external entity "functions/library/generated/trivial.xml"
functions/library.xml:20: element include: XInclude error : could not load functions/library/generated/trivial.xml, and no fallback was found
warning: failed to load external entity "functions/library/generated/lists.xml"
functions/library.xml:21: element include: XInclude error : could not load functions/library/generated/lists.xml, and no fallback was found
warning: failed to load external entity "functions/library/generated/debug.xml"
functions/library.xml:22: element include: XInclude error : could not load functions/library/generated/debug.xml, and no fallback was found
warning: failed to load external entity "functions/library/generated/options.xml"
functions/library.xml:23: element include: XInclude error : could not load functions/library/generated/options.xml, and no fallback was found
jing "$RNG" manual-full.xml
/home/teto/nixpkgs3/doc/manual-full.xml:6592:54: error: element "xi:include" not allowed here; expected the element end-tag or element "bibliography", "glossary", "index", "section", "simplesect" or "toc"
/home/teto/nixpkgs3/doc/manual-full.xml:6593:54: error: element "xi:include" not allowed here; expected the element end-tag or element "bibliography", "glossary", "index", "section", "simplesect" or "toc"
/home/teto/nixpkgs3/doc/manual-full.xml:6594:52: error: element "xi:include" not allowed here; expected the element end-tag or element "bibliography", "glossary", "index", "section", "simplesect" or "toc"
/home/teto/nixpkgs3/doc/manual-full.xml:6595:52: error: element "xi:include" not allowed here; expected the element end-tag or element "bibliography", "glossary", "index", "section", "simplesect" or "toc"
/home/teto/nixpkgs3/doc/manual-full.xml:6596:54: error: element "xi:include" not allowed here; expected the element end-tag or element "bibliography", "glossary", "index", "section", "simplesect" or "toc"
make: *** [Makefile:29: validate] Error 1

TODO
add lua to the list of setupHooks as well.

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.

@teto
Copy link
Contributor Author

@teto teto commented Mar 8, 2019

git blames @grahamc and @vcunat for lua.xml : so I would like to complete this before the upcoming nixos release. At first, I thought I could get rid of buildLuaPackage along with its doc but now it appears wiser to keep both so I need to merge the old (.xml) and my new doc (.md). How would you recommend to proceed ? I suppose it's best if I merge both the lua.xml and lua.section.md in one file but which one ? I find editing the markdown easier but ultimately am ok with converting markdown to the xml format.

@vcunat
Copy link
Member

@vcunat vcunat commented May 1, 2019

TODO: s/python/lua/g

@teto
Copy link
Contributor Author

@teto teto commented May 1, 2019

right also with the "merge" of interpreters, some of the info might be outdated. Will give it another pass if I can build the manual.

@ofborg ofborg bot removed the 6.topic: lua label May 18, 2019
@teto teto changed the title [wip] doc: update lua documentation doc: update lua documentation May 20, 2019
@nixos-discourse
Copy link

@nixos-discourse nixos-discourse commented Jun 25, 2019

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/overriding-dependent-package-buildinput-for-prosody-luadbi/3266/2

1 similar comment
@nixos-discourse
Copy link

@nixos-discourse nixos-discourse commented Jun 25, 2019

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/overriding-dependent-package-buildinput-for-prosody-luadbi/3266/2

@nixos-discourse
Copy link

@nixos-discourse nixos-discourse commented Jul 1, 2019

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/season-of-docs-gsoc-for-documentation/2402/7

@teto teto added this to the 19.09 milestone Jul 16, 2019
@teto teto removed this from the 19.09 milestone Mar 12, 2020
@teto teto added this to the 20.09 milestone Mar 12, 2020
teto added 4 commits Jun 6, 2020
Reflects the recent changes to the lua infrastructure.
Packaging from luarocks should be encouraged.
@teto
Copy link
Contributor Author

@teto teto commented Jun 6, 2020

this has been pending for too long. I finally fixed a few mistakes @vcunat if you don't mind having a look.

@teto teto mentioned this pull request Jun 9, 2020
10 tasks
@garbas garbas merged commit 29c4fc9 into NixOS:master Jun 9, 2020
13 checks passed
@teto teto deleted the lua_doc branch Jun 9, 2020
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

8 participants