Skip to content

docs/system/ip6tables: add ip6tables man page#3534

Closed
Zepp-Hanzj wants to merge 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/ip6tables
Closed

docs/system/ip6tables: add ip6tables man page#3534
Zepp-Hanzj wants to merge 1 commit into
apache:masterfrom
Zepp-Hanzj:docs/ip6tables

Conversation

@Zepp-Hanzj

Copy link
Copy Markdown
Contributor

Summary

Add comprehensive documentation for the ip6tables command.

Changes

  • Add system/iptables/ip6tables_doc.rst with complete man page
  • Document all commands: -A, -D, -I, -L, -F, -P
  • Document all options: -t, -p, -s, -d, -j, -i, -o, --sport, --dport, --icmpv6-type
  • Include practical examples for common use cases
  • Reference Kconfig options: CONFIG_SYSTEM_IP6TABLES, CONFIG_NET_IPTABLES, CONFIG_NET_IPv6

Documentation Structure

  • Name and synopsis
  • Description with targets and tables
  • Commands section with detailed explanations
  • Options section with all parameters
  • Examples section with real-world scenarios (using IPv6 addresses)
  • Configuration requirements
  • See Also references

Testing

  • Verified documentation matches actual implementation in ip6tables.c and iptables_utils.c
  • All options and commands documented are present in the source code
  • Examples use correct IPv6 syntax (fc00::1, etc.)
  • ICMPv6 options documented instead of ICMP

Impact

Related

Signed-off-by: hanzhijian hanzhijian@zepp.com

Add comprehensive documentation for the ip6tables command including:
- Name, synopsis, and description
- Targets (ACCEPT, DROP, RETURN)
- Tables (filter)
- Commands (-A, -D, -I, -L, -F, -P)
- Options (-t, -p, -s, -d, -j, -i, -o, --sport, --dport, --icmpv6-type)
- Practical examples
- Configuration requirements

The documentation is based on the actual implementation in
apps/system/iptables/ip6tables.c and iptables_utils.c.

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
@@ -0,0 +1,242 @@
==============

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why not add to nuttx/Documentation?

@cederom cederom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @Zepp-Hanzj.. but we do not document this way, please update our main documentation at nuttx/Documentation as @xiaoxiang781216 noted :-)

There are two possible locations:

  1. https://nuttx.apache.org/docs/latest/applications/netutils/index.html
    1.1. https://nuttx.apache.org/docs/latest/applications/netutils/ip6tables/index.html <- this one needs to be created with the content you provided here.
    1.2. https://nuttx.apache.org/docs/latest/applications/netutils/iptables/index.html <- this one needs an update too if you have a moment please.
  2. https://nuttx.apache.org/docs/latest/components/net/ipfilter.html <- there is a mention of iptables here but you can reference description to the applications/netutils location when ready.

@Zepp-Hanzj

Copy link
Copy Markdown
Contributor Author

Moved to apache/nuttx#19074 (Documentation/applications/system/ip6tables). Closing this PR.

@Zepp-Hanzj Zepp-Hanzj deleted the docs/ip6tables branch June 10, 2026 09:58
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.

4 participants