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

Update pihole-FTL man-pages #3883

Merged
merged 4 commits into from
Dec 10, 2020

Conversation

ganto
Copy link
Contributor

@ganto ganto commented Nov 30, 2020

By submitting this pull request, I confirm the following:

  • I have read and understood the contributors guide, as well as this entire template.
  • I have made only one major change in my proposed changes.
  • I have commented my proposed changes within the code.
  • I have tested my proposed changes, and have included unit tests where possible.
  • I am willing to help maintain this change if there are issues with it later.
  • I give this submission freely and claim no ownership.
  • It is compatible with the EUPL 1.2 license
  • I have squashed any insignificant commits. (git rebase)

What does this PR aim to accomplish?:
Ensure that all (configuration) options currently recognized by FTL 5.3.1 are properly documented in their corresponding man-pages.

How does this PR accomplish the above?:
Adding the missing configuration options read from currently released FTL's src/config.c as well as the runtime options read from the output of pihole-FTL --help

What documentation changes (if any) are needed to support this PR?:
This is a documentation change.


@yubiuser
Copy link
Member

yubiuser commented Dec 1, 2020

Thanks for that PR, but note all PRs should be filed against development

@ganto ganto changed the base branch from master to development December 1, 2020 07:40
@ganto ganto dismissed a stale review December 1, 2020 07:40

The base branch was changed.

manpages/pihole-FTL.8 Outdated Show resolved Hide resolved
manpages/pihole-FTL.8 Outdated Show resolved Hide resolved
@ganto
Copy link
Contributor Author

ganto commented Dec 1, 2020

I also adjusted the description of the arguments to be consistent with the other sub-commands and updated the man-page date that I forgot before.

DL6ER
DL6ER previously approved these changes Dec 1, 2020
@ganto
Copy link
Contributor Author

ganto commented Dec 10, 2020

Is there still anything missing?

@dschaper
Copy link
Member

You'll need to actually rebase on development or the tests will not pass.

Ensure that all configuration options currently recognized by FTL 5.3.1
are properly documented in the man page of the configuration file.

Signed-off-by: Reto Gantenbein <reto.gantenbein@linuxmonk.ch>
Signed-off-by: Reto Gantenbein <reto.gantenbein@linuxmonk.ch>
Signed-off-by: Reto Gantenbein <reto.gantenbein@linuxmonk.ch>
Signed-off-by: Reto Gantenbein <reto.gantenbein@linuxmonk.ch>
@ganto ganto force-pushed the fix/update-ftl-conf-manpage branch from b100757 to ebad56e Compare December 10, 2020 11:57
@ganto
Copy link
Contributor Author

ganto commented Dec 10, 2020

You'll need to actually rebase on development or the tests will not pass.

Thanks, I didn't get that. Done now.

@dschaper dschaper requested a review from DL6ER December 10, 2020 19:01
@dschaper
Copy link
Member

Thanks, can you also squash the 4 commits? It helps keep things clean.

@DL6ER
Copy link
Member

DL6ER commented Dec 10, 2020

I'll squash it for him.

@DL6ER DL6ER merged commit 20faa1b into pi-hole:development Dec 10, 2020
@ganto ganto deleted the fix/update-ftl-conf-manpage branch December 12, 2020 11:02
@PromoFaux PromoFaux mentioned this pull request Dec 23, 2020
@pralor-bot
Copy link

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/pi-hole-core-web-v5-2-2-and-ftl-v5-3-3-released/41998/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants