FAQ-Reader. Vorlesehilfe für NEWBEES

[hermann72pb]

Wir sind alle hier oft darüber verärgert, wie gut die Newbees unsere FAQs in WIKI lesen können. Um diese letzte Lücke zu schließen habe ich einen automatischen "Vorleser" für Newbees konstruiert.
Ich würde dringend bitten den FAQ-Reader wenigstens in trunk aufzunehmen und unter tools zu packen. Klar, muss es irgendwann mal in die stabile Version einfließen, aber lass uns erstmal testen.
Liegt das Ding unter tools, so kann es z.B. mit

freetz@freetz-linux:~/trunk$ tools/faq.sh "Filesystem image too big"
Filesystem image too big
  Das Firmware-Image passt nicht in den Flash-Speicher der ausgewählten Box.

 * Bei manchen Boxen kann dies bereits auftreten, wenn überhaupt keine zusätzlichen Pakete ausgewählt sind, da die
 grundlegende Freetz-Infrastruktur bereits einigen Platz belegt und die AVM-Images schon knapp unter dem Maximalwert
 liegen. In diesem Fall ist es notwendig, unter 'Patches' einen oder mehrere der Remove-Patches auszuwählen, um
 nicht benötigte Komponenten der Original-Firmware zu entfernen.  * Wenn viele Pakete ausgewäht sind, sollte man sich
 beschränken oder versuchen per external/Downloader/USBRoot/NFSRoot einige Komponenten aus dem Image
 auszulagern. Näheres dazu im IPPF und in WIKI * Bei den Boxen mit einem USB-Host (z.B. 7170,7270)
 kann man auch einzelne Pakete auf das externe USB-Medium (z.B. USB-Stick, USB-Festplatte) auslagern. Die Auslagerung wird
 nach dem make-Prozess automatisch von einem Skript namens external ausgeführt. Im menuconfig finden sich die
 Optionen für die Auslagerung mittels external. Im Unterschied zum USB-Root wird hier nur ein Teil der Pakete ausgelagert.
 * Wenn Pakete abgewählt wurden, sind ggfs. noch Shared Libraries ausgewählt, die nicht mehr benötigt werden (dies kann
 menuconfig nicht automatisch erkennen). Diese kann man dann manuell unter 'Advanced Options'->'Shared Libraries' abwählen -
 die auf benötigten lassen sich nicht deaktivieren. Alternativ kann man dies automatisch mittels 'make config-clean-deps'
 erledigen lassen.

gestartet werden.
Das Ganze wird noch am Terminal farbig begleitet, sodass Newbees ernsthafte Dinge schon gar nicht mehr übersehen sollten.
Es gilt nachher nur in "fwmod" an entsprechenden Stellen Aufrufe zu meinem Skript herzustellen. Und schon haben wir alles vernetzt.

Man kann es auch "englisch sprechen lassen":

freetz@freetz-linux:~/trunk$ tools/faq.sh "Language" en
Language
 Why is so much of Freetz and the development in German?:: AVM is a German company, and their hardware is mainly
 sold in the German market, where it is very popular, and generally the German-language (and German telecoms-system)
 versions of their products are the first to be released. It is therefore not a suprise that the project started in
 Germany and most of the developers are German. There are some current ideas of how to make internationalisation better,
 and although most development discussions take place in German, English-language contributions are most welcome (and will
 usually be answered in English).

Allerdings ist unsere englische FAQ-Seite bekanntlich spärlich ausgestattet. Die Themenbegriffe muss man dann natürlicherweise auch dementsprechend für Englisch anders formulieren (wenn sie denn da gewesen wären).

Ich hatte ursprünglich gedacht es mit links oder lynx -Text-Browsern zu realisieren, es wird aber für NewBee kompliziert und nicht zielführend.

MfG

 

[Silent-Tears]

Einmal kurz, da die Zeit grad für mich knapp ist: Sachn im trunk fliessen irgendwann in die nächste stabile Version ein. Von daher....

 

[linuxkasten]

Coole Sache

 

[hermann72pb]

Würde das jemand von den Svnschreibberechtigten in den trunk unter tools bitte einbauen? Stören würde es erstmal keinen. Man könnte nachher dann die Meldungen aus fwmod nach und nach dadrauf anpassen, dass sie tools/faq.sh nutzen.

Da es sowieso eine Datei ist und svn-diff die Ausführungsrechte nicht korrekt setzt, macht es wenig Sinn einen patch zu generieren. Oder?

MfG

 

[olistudent]

Hallo Hermann.

Im Anhang ist eine Version deines FAQ-Readers wie ich sie jetzt einchecken würde. Ist das so okay für dich?

Wie und wo bauen wir das in Freetz ein?
1. Filesystem Image too big
2. Makefile: Bei Auswahl von Laborfirmware
3. ???

Sollen wir eine menuconfig Option machen von der die Nutzung des FAQ Readers abhängt?

Gruß
Oliver

 

[hermann72pb]

Danke, Oliver, dass du es wieder ausgegraben hast. Ich dachte, die Sache war schon gestorben, es scheint aber wiederaufzuerstehen, wie Phönix ;-)
Aber Spass bei Seite. Hast du es ausprobiert, ob das Ding immer noch geht? Denn ich hatte es damals für damalige Struktur von FREETZ-FAQ getrimmt. Nicht dass sich da was geändert hat. Einbauen in FREETZ kann man es aber trotzdem. Denn stören würde es nicht, wenn es unter tools liegt und der eine oder der andere kann es nachher verbessern.

Wie man es am besten mit make "verheiratet" weiß ich nicht. Ich weiß auch nicht mehr, ob ich denn überhaupt einen Schutz eingebaut hatte für den Fall, dass keine Internetverbindung da ist. Ist zwar in unserem heutigen Stand eher undenkbar, weil alles mögliche von den Paketen und Patches direkt vom Netz gezogen wird, dennoch ist es wenigstens theoretisch möglich. Alleine aus dem Grund sollte man diese FAQ-Reader-Funktion abschaltbar gestalten, allerdings Default-Einstellung sollte "on" sein. "off" kann man im Expertenmodus verstecken oder mit dem Expertenmodus verunden. Ansonsten den Aufruf vom Skript immer abhängig von der Variable machen, und zwar nur dann verbieten, wenn Variable existiert und "off" ist:

[ "$FAQ_READER"="off" ] || tools/freetz_faq

Die Stellen, wo man das Ding nutzen kann sind eurer Phantasie frei gestellt. Man kann natürlich fast alles verlinken, bedarf aber viel Aufwand. Anfangen würde ich vielleicht -wie du vorschlägst- mit den Spitzenreiter von IPPF-Fragen.
Zusätzlich kann man vielleicht "make help", "make config help" und Ähnliches einbauen. "make help" kann man mit dem FAQ zur allgemeinen Informationen zum Bauen vom FREETZ-Image verlinken. "make config help" vielleicht mit dem FAQ zu den unterschiedlichen clean, precompiled und sonstigen Optionen von make.
Die Hauptbotschaft sollte lauten: Mit 2-3 Stellen anfangen und nach und nach ausbauen.
Die Vorteile von der hier vorgeschagenen Methode will ich nochmal betonen: Es sollte der Reduzierung vom Betreuungs- / Wartungsaufwand dienen. FAQ von freetz.org ist die zentrale Informationsstelle, alles wird dadrauf verlinkt.

MfG

 

[olistudent]

Das Programm scheint noch zu funktionieren...

# tools/freetz_faq "Filesystem image too big"
Filesystem image too big
  The firmware image doesn't fit into the flash memory of the selected box.

 * With some boxes, this can happen if none of the packages are selected, because the basic Freetz components use some space and
 the AVM images are just under the maximum flash size. In this case, it's neccessary to use one or more Remove-Patches under
 * If a lot packages are selected, reconsidermponents of the original firmware.
 if all packages are really neccessary, or try via FREETZ-WIKI: external/Downloader/FREETZ-WIKI:
 USBRoot/FREETZ-WIKI: NFSRoot  to externalize some of the components to reduce the image size. More Informations
 * With boxes with an USB-Host (e.g. 7170,7270) you can externalize some
 packages on an USB-Device (e.g. USB-Stick, USB-HDD).  The externalize-process is done at the end of the build process via the
 FREETZ-WIKI: external-script. At menuconfig there is an option to do the externalizing. Only parts of packages
 * If a package was disabled, maybe some shared libraries are
 still enabled, but not needed anymore. (menuconfig cannot recognize this itselve). Such libraries can manually be disabled
 under 'Advanced Options'->'Shared Libraries' - currently used libraries cannot be disabled. Another option is to do this
 via the command 'make config-clean-deps'.

Gruß
Oliver