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

Fixes doc auto-formatting oopsies [18.03] #41344

Merged

Conversation

samueldr
Copy link
Member

@samueldr samueldr commented Jun 1, 2018

See #41342

Everything applies the same way.

(cc @grahamc)

EXCEPT:

  • Two initial commits are cherry-picked

The other definitions broke term, cmdsynopsis and arg tags; spaces
inside were removed, making workdsrun-ininstead of keeping them spaced.

(cherry picked from commit aa59151)
This script is used to automatically fix issues within xml documentation
files.

The script is *for now* intended to be used ad-hoc, and the commits to
be examined.

A future discussion will define whether:

  * This commit and scripts are kept.
  * The script is extended for common use.

The biggest issue right now with the script is that it *could* in theory
destroy a valid space-less varlistentry.

The script could, in practical use, be changed and extended to normalize
some parts of the XML files, mainly:

  * A common quoting style for attributes
  * Fix-up some weird formatting automatically that xmlformat doesn't
    catch

(cherry picked from commit bc0421c)
With visual inspection that nothing got worse.
With visual inspection that nothing got worse.
Copy link
Member

@grahamc grahamc left a comment

Choose a reason for hiding this comment

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

Implicit approval based on the other one I looked at.

@xeji xeji merged commit 1723213 into NixOS:release-18.03 Jun 5, 2018
@samueldr samueldr deleted the fix/doc/formatting-oopsies-unstable_18.03 branch July 9, 2018 00:06
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