firewall: Improve the comments (documentation) #21862
Merged
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
|
@primeos, thanks for your PR! By analyzing the history of the files in this pull request, we identified @wkennington, @edolstra and @fpletz to be potential reviewers. |
|
Experience so far shows that PRs are merged faster if fragmented :) |
primeos
force-pushed
the
firewall
branch
2 times, most recently
from
d5e83ce
to
d191029
Compare
primeos
changed the title
fpletz
approved these changes
Jan 14, 2017
edolstra
reviewed
Jan 16, 2017
| @@ -1,20 +1,31 @@ | |||
| /* This module enables a simple firewall. | |||
|
|
|||
| The firewall can be customised in arbitrary ways by setting | |||
| The firewall can be customized in arbitrary ways by setting | |||
There was a problem hiding this comment.
No reason to change British to US spelling...
There was a problem hiding this comment.
Sorry, my bad, I wasn't aware of the British spelling...
FW_REFUSE was removed and nixos-fw-input was renamed to nixos-fw.
globin
reviewed
Jan 18, 2017
| additional logging, or want to reject certain packets anyway, you | ||
| can insert rules at the start of this chain. | ||
| - ‘nixos-fw-rpfilter’ is used as the main chain in the raw table, | ||
| called from the build-in ‘PREROUTING’ chain. If the kernel supports it |
Order the chains of the main table alphabetically (like in the rest of the file) and add nixos-fw-rpfilter (from the raw table) and nixos-drop (used while reloading the firewall).
- Move some attributes to the top for better visibility (that should hopefully make it easier to read and understand this module without jumping around too much). - Add some missing examples and improve some descriptions. - Reorder the mkOption attributes for consistency. - Wrap lines at 72 characters. - Use two spaces between sentences.
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
Mainly some improvements to the comments, refactoring of the "documentation" and minor fixes (code and typos):
Optional: Some questions about the file formatting:
I'll make an issue (see #21974) to collect all my technical and controversial changes before opening PRs for them.