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.

Sign up for GitHub

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

Jump to bottom

docs/build: add a short summary for some scripts #2016

Closed
wants to merge 1 commit into from
Closed

docs/build: add a short summary for some scripts #2016

wants to merge 1 commit into from

Conversation

SvenRoederer
Copy link
Contributor

This change extends the documentation of the build-system, by providing some summaries of the scripts.

  • giving an overview of a scripts function
  • a short summary how it's doing this

Only the scripts are covered, that are used by the Freifunk-Berlin firmwarebuiler too.

mweinelt
mweinelt requested changes May 8, 2020
View reviewed changes
Copy link
Contributor

@mweinelt mweinelt left a comment

Choose a reason for hiding this comment

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

Found a few typos.

docs/dev/build.rst Outdated Show resolved Hide resolved
docs/dev/build.rst Outdated Show resolved Hide resolved
docs/dev/build.rst Outdated Show resolved Hide resolved
docs/dev/build.rst Outdated Show resolved Hide resolved
docs/dev/build.rst Outdated Show resolved Hide resolved
docs/dev/build.rst Outdated Show resolved Hide resolved
@mweinelt
Copy link
Contributor

mweinelt commented May 8, 2020

/home/jenkins/workspace/gluon-ci_PR-2016/docs/dev/build.rst:61: WARNING: Inline emphasis start-string without end-string.

@SvenRoederer SvenRoederer force-pushed the scripts_doc branch 2 times, most recently from d023311 to 8294dfa Compare May 8, 2020 22:43
@SvenRoederer
Copy link
Contributor Author

now all suggestion should be added, including a fix for "WARNING: Inline emphasis start-string without end-string."

@SvenRoederer
Copy link
Contributor Author

just added an note, that patch.sh will also do the checkout to the filesystem.

@mweinelt mweinelt added 0. type: enhancement The changeset is an enhancement 3. topic: build This is about the build system 3. topic: docs Topic: Documentation labels May 12, 2020
@mweinelt
Copy link
Contributor

Maybe @bobcanthelpyou can review these docs changes?

@mweinelt mweinelt added the 2. status: waiting-on-review Awaiting review from the assignee but also interested parties. label May 12, 2020
rotanid
rotanid requested changes May 25, 2020
View reviewed changes
docs/dev/build.rst Outdated Show resolved Hide resolved
@rotanid rotanid requested a review from neocturne May 25, 2020 23:13
@SvenRoederer SvenRoederer requested review from rotanid and mweinelt May 25, 2020 23:24
neocturne
neocturne requested changes May 28, 2020
View reviewed changes
Copy link
Member

@neocturne neocturne left a comment

Choose a reason for hiding this comment

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

Thanks for these doc improvements. See my comments for a few more things to fix.

docs/dev/build.rst Outdated Show resolved Hide resolved
docs/dev/build.rst Outdated Show resolved Hide resolved
docs/dev/build.rst Show resolved Hide resolved
docs/dev/build.rst Show resolved Hide resolved
docs/dev/build.rst Show resolved Hide resolved
docs/dev/build.rst Outdated Show resolved Hide resolved
@neocturne neocturne added 2. status: waiting-on-author Waiting on some action from the author and removed 2. status: waiting-on-review Awaiting review from the assignee but also interested parties. labels May 31, 2020
@SvenRoederer
docs/build: add a short summary for some scripts
5585f13 
This summaries giving an overview of a scripts function and a short summary how
it's doing this.
Only the scripts are covered, that are used by the Freifunk-Berlin firmwarebuiler too.
@SvenRoederer SvenRoederer requested a review from neocturne May 31, 2020 21:15
@neocturne
Copy link
Member

Thanks, I reworded a few descriptions and merged this.

@neocturne neocturne closed this May 31, 2020
@SvenRoederer SvenRoederer deleted the scripts_doc branch June 1, 2020 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rotanid rotanid Awaiting requested review from rotanid

@mweinelt mweinelt Awaiting requested review from mweinelt

@neocturne neocturne Awaiting requested review from neocturne

Assignees
No one assigned
Labels
0. type: enhancement The changeset is an enhancement 2. status: waiting-on-author Waiting on some action from the author 3. topic: build This is about the build system 3. topic: docs Topic: Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@SvenRoederer @mweinelt @neocturne @rotanid