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

nixos/cassandra: Convert option docs to markdown #177379

Merged
merged 1 commit into from
Jun 23, 2022

Conversation

roberth
Copy link
Member

@roberth roberth commented Jun 12, 2022

Description of changes

Giving #176146` a spin. It's unmerged, so it appears in the diff.

Findings: if you get invalid xml errors in "intermediate.xml", you've forgot mdDoc.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 22.11 Release Notes (or backporting 22.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: module (update) This PR changes an existing module in `nixos/` labels Jun 12, 2022
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Jun 12, 2022
resolution, etc), and the Right Thing is to use the address
associated with the hostname (it might not be).

Setting listen_address to 0.0.0.0 is always wrong.
Setting {option}`listenAddress` to `0.0.0.0` is always wrong.
Copy link
Contributor

Choose a reason for hiding this comment

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

completely unrelated to this change: it would be cool if we could, at some point in the future, use this for auto-linking options in the html manual. don't think that's feasible even in the current docbook state, but it would be nice to have :)

nixos/modules/services/databases/cassandra.nix Outdated Show resolved Hide resolved
@roberth roberth force-pushed the markdown-cassandra branch from f50934e to 593f3bb Compare June 21, 2022 11:18
@github-actions github-actions bot removed the 8.has: documentation This PR adds or changes documentation label Jun 21, 2022
@roberth roberth force-pushed the markdown-cassandra branch from 593f3bb to fe11145 Compare June 21, 2022 11:21
@roberth roberth marked this pull request as ready for review June 21, 2022 11:21
@pennae pennae merged commit db0dcf1 into NixOS:master Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants