freifunk-franken
/
firmware
9
7
Fork 13
Code Issues 48 Pull Requests 7 Releases 17 Wiki Activity

README.md: Various Updates #5

Closed
Felix wants to merge 4 commits from (deleted):readme into master
pull from: (deleted):readme
merge into: freifunk-franken:master
Conversation 4 Commits 4 Files Changed 1 +12
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 25cb0a90be - Show all commits

12
README.md
View File

@ -29,6 +29,11 @@ Die Daten des BSP werden nie alleine verwendet. Zuerst werden immer die Daten au
Die BSP-Datei wird durch das Buildscript automatisch als dot-Script geladen, somit stehen dort alle Funktionen zur Verfügung.
Das Buildscript generiert ein dynamisches sed-Script. Dies geschieht, damit die Templates mit den richtigen Werten gefüllt werden können.
### `./buildscript selectvariant`
Hier wählt man aus ob man Node Firmware oder Layer3 Firmware bauen möchte:
Felix marked this conversation as resolved Outdated
adschm commented 2020-12-13 00:14:01 +01:00
Outdated
Review
Copy Link

"Des Weiteren". Ich würde das aber ganz anders machen:
"Hier wählt man aus ob man Node Firmware oder Layer3 Firmware bauen möchte:"

"Des Weiteren". Ich würde das aber ganz anders machen: "Hier wählt man aus ob man Node Firmware oder Layer3 Firmware bauen möchte:"
* `./buildscript selectvariant [node/layer3]`
* Um die verschiedenen Varianten zu sehen, kann `./buildscript selectvariant help` ausgeführt werden.
Felix marked this conversation as resolved Outdated
adschm commented 2020-12-13 00:14:20 +01:00
Outdated
Review
Copy Link

"verschiedenen" klein schreiben

"verschiedenen" klein schreiben
### `./buildscript prepare`
* Sourcen werden in einen separaten src-Folder geladen, sofern diese nicht schon da sind. Zu den Sourcen zählen folgende Komponenten:
* OpenWrt
@ -48,7 +53,11 @@ Dieses Kommando arbeitet folgendermaßen:
* Config-Format vereinfachen
* Config ins BSP zurück speichern
### `./buildscript updatefeeds`
Aktualisiert die OpenWrt Feeds für zusätzliche Pakete, die in die Firmware eingebaut werden. Dabei werden die Referenzen im build/ Verzeichnis aktualisiert. Dieser Schritt wird bereits von `./buildscript prepare` übernommen, daher ist dies nur bei manuellen Änderungen der Feeds nötig.
Felix marked this conversation as resolved Outdated
adschm commented 2020-12-13 00:21:36 +01:00
Outdated
Review
Copy Link

Der zweite Satz ist misleading. Wir aktualisieren die Liste aller Feeds, installieren aber immer nur die, die war ausgewählt haben.

Weiterhin Tippfehler bei buildscript prepare.

Ich würde das anders schreiben:
"Aktualisiert die OpenWrt Feeds für zusätzliche Pakete, die in die Firmware eingebaut werden. Dabei werden die Referenzen im build/ Verzeichnis aktualisiert. Dieser Schritt wird bereits von ./buildscript prepare übernommen, daher ist dies nur bei manuellen Änderungen der Feeds nötig."

Der zweite Satz ist misleading. Wir aktualisieren die Liste _aller_ Feeds, installieren aber immer nur die, die war ausgewählt haben. Weiterhin Tippfehler bei buildscript prepare. Ich würde das anders schreiben: "Aktualisiert die OpenWrt Feeds für zusätzliche Pakete, die in die Firmware eingebaut werden. Dabei werden die Referenzen im build/ Verzeichnis aktualisiert. Dieser Schritt wird bereits von `./buildscript prepare` übernommen, daher ist dies nur bei manuellen Änderungen der Feeds nötig."
### `./buildscript build`
Sollte man am besten mit Hilfe des Tools 'screen' oder ähnlichem laufen lassen um einen Abbruch des Builds bei Verbindungsproblemen oder ähnlichem zu verhindern.
Felix marked this conversation as resolved Outdated
adschm commented 2020-12-13 00:22:41 +01:00
Outdated
Review
Copy Link

"in einem screen"
Besser: ... mit Hilfe des Tools 'screen' o.ä. ...

"in einem screen" Besser: ... mit Hilfe des Tools 'screen' o.ä. ...
* prebuild
* $target/files aufräumen
* (In $target/files liegen Dateien, die später direkt im Ziel-Image landen)
@ -61,6 +70,9 @@ Dieses Kommando arbeitet folgendermaßen:
* postbuild
* board_postbuild() wird aufgerufen
### `./buildscript buildall`
Kann verwendet werden um für alle BSPs Firmware zu bauen. Das kann jedoch mehrere Stunden dauern.
Felix marked this conversation as resolved Outdated
adschm commented 2020-12-13 00:23:25 +01:00
Outdated
Review
Copy Link

Punkt statt Komma:

"Kann verwendet werden um für alle BSPs Firmware zu bauen. Das kann jedoch mehrere Stunden dauern."

Punkt statt Komma: "Kann verwendet werden um für alle BSPs Firmware zu bauen. Das kann jedoch mehrere Stunden dauern."
## Erweiterung eines BSPs
Beispielhaftes Vorgehen um den WR1043V2 zu unterstützen.