RFC: modify buildsystem docs in README.md #825

Akira25 · 2020-06-28T18:33:02Z

This is meant to be an first improvement for the issues in documentation addressed in #824. This commit mainly takes some of documentation of weimarnetz and adds that to our README.md

README.md

SvenRoederer · 2020-06-28T20:23:28Z

Improved docs are always welcome.

Before putting much work into this, we should discuss on #765 as it will change many of the existing folders.

Akira25 · 2020-07-03T12:33:26Z

Improved docs are always welcome.

Before putting much work into this, we should discuss on #765 as it will change many of the existing folders.

I'm already finished. I'd prefer to have this merged fairly soon, as anyone how like to use our buildsystem now, would need to invest much debugging effort into it, until he gets to know, where to configure anything.

Akira25 · 2020-07-03T12:40:18Z

Besides that, regarding our current development velocity, I don't think we will have a decision on #765 within the next 1.5 Years.

README.md

foudfou

Very helpful!

README.md

SvenRoederer · 2020-07-08T19:55:11Z

README.md

-* a tutorial ([en](https://wiki.freifunk.net/Berlin:Firmware:En:Howto) / [de](https://wiki.freifunk.net/Berlin:Firmware:Howto)) on router configuration
+More user relevant information on the firmware are on the wiki page at:
+https://wiki.freifunk.net/Berlin:Firmware. There you can also find the 
+* [ReleaseNotes](https://wiki.freifunk.net/Berlin:Firmware/v1.0.2) and


Hedy-1.0.6 is out and should be referenced here. But this can be a separate commit.

Is it possible to use a variable which accesses the latest tagged release version. (for the separate commit which will someday materialize)

As the Readme belongs to the Codebase of a release, releasing something with an old or template value here, will end in having this template in the released Readme. Updating it after releasing creates a new version of the file (commit) which should cause to release again. So the never ending loop has started ...

In long-term I suggest to get rid of the release-history in the Readme of the firmware-buildsystem, like I did here: https://github.com/freifunk-berlin/firmware/tree/745bda009b313cf3ce4eaacd82e232a4644f8a03

As the page for v1.0.6 does not exist, I linked the page for v1.0.3

SvenRoederer · 2020-07-08T19:58:07Z

README.md

+
+patches/          - Patches against the OpenWRT directory  
+packagelists/     - Package Lists  
+profiles/         - List of router profiles for each architecture - names come 


probably use "target architecture" to keep the common target term

SvenRoederer · 2020-07-08T20:02:48Z

README.md

+patches/          - Patches against the OpenWRT directory  
+packagelists/     - Package Lists  
+profiles/         - List of router profiles for each architecture - names come 
+                      from the Imagebuilder


is it worth to mention "make info" here?

README.md

SvenRoederer · 2020-07-08T20:12:50Z

README.md

+The default target is `ar71xx-generic`. For a complete list of supported targets
+look at `configs/` for the target-specific configs. Each of these targets need a
+matching file in `profiles/` with the profiles (boards) that should be build
+with the imagebuilder.


"should be build by the imagebuilder"?

"should be built by" would be the queen's english.

SvenRoederer · 2020-07-08T20:15:14Z

README.md

+should work at least in theory. Wifi should be ath9k / ath10k. mt76 also appears
+to work. 
+
+You can use the Imagebuilder to get a list of all supported models for a


Probably the better place, than the mentioned above, to reference "make info" if we want to reference it at all.

SvenRoederer · 2020-07-08T20:23:29Z

README.md

 [http://buildbot.berlin.freifunk.net/buildbot/unstable/](http://buildbot.berlin.freifunk.net/buildbot/unstable/)
-Note that in the directory there is no reference to the branch name; unstable builds can be identified by build number only.
+Note that in the directory there is no reference to the branch name; unstable
+builds can be identified by their build number only.


Are you willing to referernce the VERSION.txt file here

README.md

…m. Wrap lines to meet needs of 80-char-terminal.

SvenRoederer

So far thanks for your work

SvenRoederer · 2020-08-18T20:59:09Z

README.md

-* a tutorial ([en](https://wiki.freifunk.net/Berlin:Firmware:En:Howto) / [de](https://wiki.freifunk.net/Berlin:Firmware:Howto)) on router configuration
+More user relevant information about the firmware are on the wiki page at: https://wiki.freifunk.net/Berlin:Firmware.
+There you can also find the
+* [ReleaseNotes](https://wiki.freifunk.net/Berlin:Firmware/v1.0.3)


To reflect the current state: It feels to me, that we should not reference the wiki here, as nobody takes care of updating the pages. It seems best to reference the Github-release pages (https://github.com/freifunk-berlin/firmware/releases) here, which link to the correct ReleaseNotes of the corresponding release.

SvenRoederer · 2020-08-18T21:00:10Z

README.md

+
+The idea is to download OpenWrt via git, patch it with all patches in the
+`patches/` folder and configure it according to the configuration snippets in
+`configs`.  Then use the OpenWrt buildsystem to build all packages and the


should be configs/ , as it's a folder

SvenRoederer · 2020-08-18T21:01:30Z

README.md

+`patches/` folder and configure it according to the configuration snippets in
+`configs`.  Then use the OpenWrt buildsystem to build all packages and the
+Imagebuilder and use the latter to assemble the final image with lists of
+packages in packages for the router.


"with lists of packages in packaglists/ for the router.

SvenRoederer · 2020-08-18T21:02:58Z

README.md

+`configs`.  Then use the OpenWrt buildsystem to build all packages and the
+Imagebuilder and use the latter to assemble the final image with lists of
+packages in packages for the router.
+All additional packages can be found at http://github.com/freifunk-berlin/packages_berlin.


should we mention "gluon-packages" and "freifunk-potsdam-packages" also. (not shure if ffp-packages made it up to this repo already)

SvenRoederer · 2020-08-18T21:03:45Z

README.md

+```
+:: Settings
+
+config.mk             - OpenWrt git repository, revision, select what package lists to build


"OpenWrt git repository, revision" is controlled by modules-file

SvenRoederer · 2020-08-18T21:04:43Z

README.md

+:: Settings
+
+config.mk             - OpenWrt git repository, revision, select what package lists to build
+feeds.conf            - OpenWrt feeds.conf that is used for the package feeds during build


"feeds.conf" is converted to modules

SvenRoederer · 2020-08-18T21:07:16Z

README.md

+config.mk             - OpenWrt git repository, revision, select what package lists to build
+feeds.conf            - OpenWrt feeds.conf that is used for the package feeds during build
+
+configs/                  - further configurations


"further configurations" replace by "snippets of the OpenWrt config-options (compare to call "make menuconfig" in openwrt/)" or something alike

SvenRoederer · 2020-08-18T21:08:28Z

README.md

-some boards to initially install OpenWrt.
+As you notice there are several different image variants ("manual", "notunnel",
+etc.). 
+ These different *packages lists* are defined in `packages/`. See the


packages/ --> packagelists/

You talk here on the "firmware" folder, right? Then this packages folder is just the storage-repo of all packages available.These packages will be included according to the flavors in packagelists/ to the image or used as source then running opkg install on the router.

SvenRoederer · 2020-08-18T21:16:34Z

README.md

+All branches with names not fitting the "X.Y.Z" pattern are built and put into
+the "unstable" directory: [http://buildbot.berlin.freifunk.net/buildbot/unstable/](http://buildbot.berlin.freifunk.net/buildbot/unstable/)
+Note that in the directory there is no reference to the branch name; unstable
+builds can be identified by build number only.


referencing the VERSION.txt file? As this is the best place to look up on which branch and revision a build is based on.

SvenRoederer · 2020-08-18T21:17:42Z

README.md

-the codename in the README and config files (./configs/*)
+For a new release, create a new branch. The branch name must be a semantic
+version number. Make sure you change the semantic version number and, for major
+releases, the codename in the README and config files (`./configs/`)


(./configs/) --> in all other places we did not prefix the path by "./"

Akira25 · 2020-10-10T16:21:06Z

@SvenRoederer There were 37 (±2) requests for changes in total. Please feel free to include them into the README-File. It might be faster to do it by yourself, then writing me, what I should change. I will no longer invest effort into this. You seem to be the only one, who knows how this buildsystem works.

Sadly, the documentation will still document a different state than the current one.

SvenRoederer · 2020-10-20T00:01:15Z

@SvenRoederer There were 37 (±2) requests for changes in total. Please feel free to include them into the README-File. It might be faster to do it by yourself, then writing me, what I should change.

That's the downside of having the PR source from your private Repo-fork ... Only you have permission to commit to it. My impression was, that the most of the open changes were were most "consistency of terms" and generic comments.

I will no longer invest effort into this. You seem to be the only one, who knows how this buildsystem works.

I got used to it and found some smart ideas inside. Sadly I seems to be the only one still working on it, as the "old" developers (@sarumpaet @booo @andrenarchy @lynxis ) seem to have retired.

Sadly, the documentation will still document a different state than the current one.

Indeed your updated documentation somehow based on the outdated system before switching to "modules"-file.

But thanks for your work so far. I'll reopen, in case someone else likes to continue here.

based on PR #825

SvenRoederer reviewed Jun 28, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

SvenRoederer added buildsystem enhancement labels Jun 28, 2020

SvenRoederer mentioned this pull request Jul 3, 2020

implement Gluon build-framework #765

Draft

SvenRoederer requested changes Jul 3, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Show resolved Hide resolved

foudfou reviewed Jul 4, 2020

View reviewed changes

README.md Show resolved Hide resolved

foudfou reviewed Jul 4, 2020

View reviewed changes

SvenRoederer reviewed Jul 7, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer reviewed Jul 7, 2020

View reviewed changes

README.md Show resolved Hide resolved

SvenRoederer reviewed Jul 7, 2020

View reviewed changes

README.md Show resolved Hide resolved

SvenRoederer reviewed Jul 7, 2020

View reviewed changes

README.md Show resolved Hide resolved

SvenRoederer reviewed Jul 7, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer mentioned this pull request Jul 7, 2020

README.md: partly incorporate changes from discussion on MR #782. #829

Closed

SvenRoederer reviewed Jul 8, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer reviewed Jul 8, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer reviewed Jul 8, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer reviewed Jul 8, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer reviewed Jul 8, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer reviewed Jul 8, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

SvenRoederer reviewed Jul 8, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

Akira25 mentioned this pull request Jul 9, 2020

Documentation for Firmware Build System #824

Open

README.md: adjust documentation to match current state of build syste…

c283aac

…m. Wrap lines to meet needs of 80-char-terminal.

SvenRoederer requested changes Aug 18, 2020

View reviewed changes

github-actions bot added the has conflicts label Sep 30, 2020

Akira25 closed this Oct 10, 2020

SvenRoederer reopened this Oct 20, 2020

SvenRoederer added a commit that referenced this pull request Jun 27, 2021

README: some improvements to document the file-structure

946be04

based on PR #825

SvenRoederer added a commit that referenced this pull request Jun 27, 2021

README: some improvements to document the file-structure

b906022

based on PR #825

SvenRoederer added a commit that referenced this pull request Jul 11, 2021

README: some improvements to document the file-structure

01e2b17

based on PR #825

SvenRoederer added a commit that referenced this pull request Jul 11, 2021

README: some improvements to document the file-structure

fbcfab4

based on PR #825

SvenRoederer mentioned this pull request Jul 11, 2021

README: some improvements to document the file-structure #865

Closed

SvenRoederer added a commit that referenced this pull request Jul 18, 2021

README: some improvements to document the file-structure

0c7c2d7

based on PR #825

FFHener deleted the branch freifunk-berlin:master June 24, 2024 08:02

FFHener closed this Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RFC: modify buildsystem docs in README.md #825

RFC: modify buildsystem docs in README.md #825

Akira25 commented Jun 28, 2020

SvenRoederer commented Jun 28, 2020

Akira25 commented Jul 3, 2020

Akira25 commented Jul 3, 2020

foudfou left a comment

SvenRoederer Jul 8, 2020

pmelange Jul 10, 2020

SvenRoederer Jul 10, 2020

Akira25 Aug 4, 2020

SvenRoederer Jul 8, 2020

SvenRoederer Jul 8, 2020

SvenRoederer Jul 8, 2020

pmelange Jul 10, 2020 •

edited

Loading

SvenRoederer Jul 8, 2020

SvenRoederer Jul 8, 2020

SvenRoederer left a comment

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

SvenRoederer Aug 18, 2020

Akira25 commented Oct 10, 2020

SvenRoederer commented Oct 20, 2020

RFC: modify buildsystem docs in README.md #825

RFC: modify buildsystem docs in README.md #825

Conversation

Akira25 commented Jun 28, 2020

SvenRoederer commented Jun 28, 2020

Akira25 commented Jul 3, 2020

Akira25 commented Jul 3, 2020

foudfou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmelange Jul 10, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SvenRoederer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Akira25 commented Oct 10, 2020

SvenRoederer commented Oct 20, 2020

pmelange Jul 10, 2020 •

edited

Loading