Skip to content

doc: Add Kconfig section [backport 2020.01]#13153

Closed
leandrolanzieri wants to merge 1 commit intoRIOT-OS:2020.01-branchfrom
leandrolanzieri:backport/pr/doc/kconfig_in_riot
Closed

doc: Add Kconfig section [backport 2020.01]#13153
leandrolanzieri wants to merge 1 commit intoRIOT-OS:2020.01-branchfrom
leandrolanzieri:backport/pr/doc/kconfig_in_riot

Conversation

@leandrolanzieri
Copy link
Copy Markdown
Contributor

Backport of #13040

Contribution description

This adds information regarding the usage of Kconfig from an user perspective and in-depth information on how it is currently integrated into RIOT's build system.

Testing procedure

Run make doc and read 'Kconfig in RIOT' section.

Issues/PRs references

None

This adds information regarding the usage of Kconfig from an user
perspective and in-depth information on how Kconfig is currently
integrated to RIOT's build system.
@leandrolanzieri leandrolanzieri added Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Process: release backport Integration Process: The PR is a release backport of a change previously provided to master TF: Config Marks issues and PRs related to the work of the Configuration Task Force labels Jan 17, 2020
@PeterKietzmann
Copy link
Copy Markdown
Member

@fjmolinas, @aabadie what is the consensus of your discussion in #13040 about backporting documentation PRs? Personally, I think it doesn't hurt and it even improves the case that a user builds the doc on his own.

@aabadie
Copy link
Copy Markdown
Contributor

aabadie commented Jan 17, 2020

it even improves the case that a user builds the doc on his own.

which is very unlikely to happen...

@fjmolinas
Copy link
Copy Markdown
Contributor

which is very unlikely to happen...

Not really, a lot of documentation is markdown. I never check that online. And it is the case here.

@fjmolinas
Copy link
Copy Markdown
Contributor

Not really, a lot of documentation is markdown. I never check that online. And it is the case here.

I do not build it, but I do not check it online either.

@aabadie
Copy link
Copy Markdown
Contributor

aabadie commented Jan 17, 2020

@fjmolinas, as a core maintainer, are you that often reading documentation on the release branch instead of master ? Because this is what backporting is about.

@kaspar030
Copy link
Copy Markdown
Contributor

backporting documentation PRs

The idea is to backport "fixes", not "missing features". We did backport fixes to mistakes in docs (during hard freeze). We did not so far backport PRs adding missing documentation.

But IMO, this is @fjmolinas's call, he's managing the release, and this is not something outrageously against our conventions. It just means more work within the release process.

@leandrolanzieri
Copy link
Copy Markdown
Contributor Author

In this release we started the process of this new feature, but the release itself would not contain any explanation nor usage guides without this backport. I totally understand what @aabadie points out, that the latest docs are always online. But the release should be self-contained in this matter, take for instance someone who gets the .zip version of the release.

It just means more work within the release process.

What's the extra work for adding this docs?

In any case, I'm OK with whatever @fjmolinas thinks is best here.

@aabadie
Copy link
Copy Markdown
Contributor

aabadie commented Jan 31, 2020

Finally, it was decided to not backport this one, so closing it.

@aabadie aabadie closed this Jan 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Process: release backport Integration Process: The PR is a release backport of a change previously provided to master TF: Config Marks issues and PRs related to the work of the Configuration Task Force

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants