[doc] remove indentation #24515
Closed
[doc] remove indentation #24515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@Zimmi48, thanks for your PR! By analyzing the history of the files in this pull request, we identified @joachifm, @matthiasbeyer and @yesbox to be potential reviewers. |
The standard in XML doc files in nixpkgs is not to use indentation. The files changed by this commit were found by browsing the NixOS manual and spotting odd indentation in command listings, as well as spurious new lines at the end of such listings. This commit should fix all these problems in the NixOS manual.
Zimmi48
force-pushed
the
doc-remove-indentation
branch
from
3432218
to
bbaefee
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
The standard in XML doc files in nixpkgs is not to use indentation.
The files changed by this commit were found by browsing the NixOS manual and spotting odd indentation in command listings, as well as spurious new lines at the end of such listings.
This commit should fix all these problems in the NixOS manual.
Remarks
This is going to seem odd but I did not test the resulting generated doc, even though I'm pretty sure that my fix is correct. So before merging this patch, someone should test this or instruct me on how to test.I did test it following instructions found in the manual and I can confirm that the fix is correct.A lighter fix would have been to remove the indentation only for
<programlisting>. Since the standard seems to be "no indentation", and in order to remind people not to use indentation, I rather chose to remove it entirely from the incriminated files.If the patch is considered OK, it should be merged quickly (and probably backported to 17.03) because it is likely to create a lot of merge conflicts if we wait too long and other people propose other improvements to the affected files.