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

coqPackages: doc #108937

Merged
merged 2 commits into from Jan 11, 2021
Merged

coqPackages: doc #108937

merged 2 commits into from Jan 11, 2021

Conversation

CohenCyril
Copy link
Contributor

@CohenCyril CohenCyril commented Jan 10, 2021

Motivation for this change

Changing bullet style to fix the rendering
cf #105877 (comment)

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.

changing bullet style
@siraben
Copy link
Member

siraben commented Jan 10, 2021

You can test to see if this worked by running this in your checkout of Nixpkgs.

$ cd doc
$ nix-build && nix-shell -p python3 --run 'python3 -m http.server --directory ./result/share/doc/nixpkgs'

For me it still renders incorrectly.

Screen Shot 2021-01-10 at 19 47 26

@siraben
Copy link
Member

siraben commented Jan 10, 2021

You may want to change the type of list using the admonitions added by @jtojnar used for instance in the markdown version of the cross-compilation chapter.

`system`

: This is a two-component shorthand for the platform. Examples of this would be "x86_64-darwin" and "i686-linux"; see `lib.systems.doubles` for more. The first component corresponds to the CPU architecture of the platform and the second to the operating system of the platform (`[cpu]-[os]`). This format has built-in support in Nix, such as the `builtins.currentSystem` impure string.

`config`

: This is a 3- or 4- component shorthand for the platform. Examples of this would be `x86_64-unknown-linux-gnu` and `aarch64-apple-darwin14`. This is a standard format called the "LLVM target triple", as they are pioneered by LLVM. In the 4-part form, this corresponds to `[cpu]-[vendor]-[os]-[abi]`. This format is strictly more informative than the "Nix host double", as the previous format could analogously be termed. This needs a better name than `config`!

`parsed`

: This is a Nix representation of a parsed LLVM target triple with white-listed components. This can be specified directly, or actually parsed from the `config`. See `lib.systems.parse` for the exact representation.

This renders as
Screen Shot 2021-01-10 at 19 49 44

@ryantm do you think this is appropriate?

@@ -3,37 +3,37 @@
## Coq derivation: `coq`

The Coq derivation is overridable through the `coq.override overrides`, where overrides is an attribute set which contains the arguments to override. We recommend overriding either of the following
+ `version` (optional, defaults to the latest version of Coq selected for nixpkgs, see `pkgs/top-level/coq-packages` to witness this choice), which follows the conventions explained in the `coqPackages` section below,
Copy link
Contributor

Choose a reason for hiding this comment

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

You would likely need an empty line between the paragraph and the list item. This is why I prefer Docbook over Markdown 😆

@vbgl vbgl merged commit e87aef0 into NixOS:master Jan 11, 2021
@CohenCyril
Copy link
Contributor Author

I don't understand, despite this PR, https://nixos.org/manual/nixpkgs/unstable/#sec-language-coq is still broken...

@jtojnar
Copy link
Contributor

jtojnar commented Jan 13, 2021

Perhaps it did not update yet? You can test it locally by running nix-build pkgs/top-level/release.nix -A manual in the nixpkgs directory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants