nixos/davfs2: fix rfc42 conversion, make settings and extraConfig mutually exclusive, and other cleanup

[eclairevoyant]

Description of changes

Fixes #302243.
Also fixes some additional issue around spurious warnings, mentioned in the comments of #297014.

Also, update the settings option to allow multiple sections (breaking change), and ensure it's mutually exclusive with extraConfig (breaking change).

Finally, update the config generation to conform to the following rules:

General Syntax Rules

Lines that only contain spaces and tabs (empty lines) are ignored.

# indicates a comment. The rest of the line is ignored.

\ is the escape character.

"" is used for quotation.

If a value contains one of the special characters space, tab, #, \, or ", this character must be escaped by a preceding \. Use \ instead of , \# instead of #, \\ instead of \ and \" instead of ".

Values containing spaces, tabs or # may instead be enclosed in double quotes. But " and ’ must be escaped even within double quotes. If the starting line of a section is enclosed in double quotes, the square brakets must be within the quotes (like "[/home/otto/with space]").

Boolean option values (yes/no) must be given as numerical value. 0 for no, 1 for yes.

• fix the warning that deprecates extraConfig
• clarify warning message
• remove lib.mdDoc (no-op)
• remove with lib;
• fix settings option
• ensure extraConfig and settings are mutually exclusive

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• 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/)
• 24.05 Release Notes (or backporting 23.05 and 23.11 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
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[eclairevoyant]

@firecat53 would you be able to test this? I've verified that (at least with only specifying settings and not extraConfig) the config format follows the manual, and doesn't spit out warnings when building, but I'm not familiar with davfs.

[happysalada]

This looks good to me, i have to be honest i dont have a lot of time to spend here. Ill check again in a few days and will merge (ideally when someone has been able to test)

[firecat53]

I'm hoping to get it tested today or tomorrow! Thanks! Apr 10, 2024 14:18:53 Yt ***@***.***>:

…

This looks good to me, i have to be honest i dont have a lot of time to spend here. Ill check again in a few days and will merge (ideally when someone has been able to test) — Reply to this email directly, view it on GitHub[#302689 (comment)], or unsubscribe[https://github.com/notifications/unsubscribe-auth/AAEKWMMHTR7KSGJQ64NBJV3Y4WUDZAVCNFSM6AAAAABF5QCELOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANBYGQ2TCOJXGM]. You are receiving this because you were mentioned. [Tracking image][https://github.com/notifications/beacon/AAEKWML5SAVT2DO2FED26GTY4WUDZA5CNFSM6AAAAABF5QCELOWGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTT2DDSYK.gif]

[firecat53]

Thanks for your patience! Finally figured out how to test and it works for me. Appreciate the support!

[therealpxc]

Thanks for your patience! Finally figured out how to test and it works for me. Appreciate the support!

👋 I was just about to ask you on Discourse to come here and share your experience with the PR to help move it forward, but I see now that's what you were working to do all along. Thanks :)

[eclairevoyant]

Okay, I think the manpage is wrong; it claims that " and ' need to be escaped when quoting, but I don't see a reason for escaping ' - they probably intended to say that " and \ should be escaped, and messed up a copy-paste somewhere...

[happysalada]

@eclairvoyant are we good to go , or do you want to make further changes ?

[eclairevoyant]

Fixed it to escape double-quotes and backslashes. I think that makes far more sense given the context of the manpage.

Should be good to go now.

[nixos-discourse]

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/can-we-please-stop-breaking-stuff-willy-nilly/48496/39