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

gnrc/ipv6_auto_subnets: improve documentation about subnet generation and RIO #18398

Merged
merged 3 commits into from
Aug 16, 2022

Conversation

benpicco
Copy link
Contributor

@benpicco benpicco commented Aug 3, 2022

Contribution description

This better illustrates how subnet generation works and why we need the Route Information Option in a Router Advertisement to the upstream network for this to properly work.

Testing procedure

Read the documentation generated by CircleCI and see if things make sense.

Issues/PRs references

@github-actions github-actions bot added Area: doc Area: Documentation Area: network Area: Networking Area: sys Area: System labels Aug 3, 2022
@benpicco benpicco requested a review from fabian18 August 3, 2022 18:30
@benpicco benpicco added CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation and removed Area: sys Area: System labels Aug 3, 2022
@github-actions github-actions bot added Area: sys Area: System Area: tools Area: Supplementary tools labels Aug 4, 2022
@benpicco benpicco requested a review from chrysn August 4, 2022 07:18
@@ -1,2 +1,3 @@
*/vendor/*
dist/tools/fixdep/fixdep.c
*.svg
Copy link
Member

Choose a reason for hiding this comment

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

If you use git add -p and then hit a for the file, the whitespaces are removed if you use the following git config:

[apply]
	whitespace = fix
[core]
	whitespace = blank-at-eol,blank-at-eof,trailing-space,space-before-tab

As neither tabs nor trailing whitespaces have a syntactical meaning in SVG files, I really don't see a reason why those should be ignored.

@chrysn
Copy link
Member

chrysn commented Aug 4, 2022 via email

@miri64
Copy link
Member

miri64 commented Aug 4, 2022

SVG files are primarily edited in GUIs, and here even just checked in pregenerated b/c the actual source can't be built in the automation. Requiring whitespace cleanliness would be excessive here IMO. (Yes it's kind of a bug in the generator, but then it'll be better here when it''s fixed there, and until that semi-manual cleanups don't do noone no good).

Ok, fine...

@benpicco benpicco requested review from maribu and kfessel August 10, 2022 15:01
@benpicco benpicco added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Aug 16, 2022
@benpicco benpicco force-pushed the gnrc_ipv6_auto_subnets-doc branch from 0c70b86 to 5b5c5cc Compare August 16, 2022 09:31
@benpicco benpicco merged commit d1ce899 into RIOT-OS:master Aug 16, 2022
@benpicco benpicco deleted the gnrc_ipv6_auto_subnets-doc branch August 16, 2022 15:00
@maribu maribu added this to the Release 2022.10 milestone Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation Area: network Area: Networking Area: sys Area: System Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants