Die Dokumentation zählt nicht gerade zu den Glanzpunkten des Kernels. Viele andere quelloffenen Projekte beweisen, daß es durchaus auch anders geht. Gerade mit Hilfsprogrammen wie Doxygen lassen sich gute Schnittstellendokumentationen im HTML-Format erzeugen, die folgende Anforderungen befriedigen + übersichtliche Darstellung auch der Datenrichtung und der gedachten Absicht (sowie Möglichkeit zur Plazierung von Beispielen). + Verwendbarkeit im Internet + Leicht verwendbare (klickbare) Querbezüge (ein Klick und ich weiß was of_platform ist).
Ich weiß nicht, ob die Intention der Kernelentwickler in einer Zukunftssicherung als Buchautoren zu suchen ist - aber bei den vielen schlecht dokumentierten Funktionen und gerade den API-Änderungen kommt einem dieser Verdacht schon auf.
Zwei Beispiele: ein etwas älterer Treiber verwendet die Struktur of_device - die Netzsuche erbrachte Andeutungen, daß diese gegen of_platform getauscht worden wäre. Wunderbar. Wo finde ich die Beschreibung der alten und der neuen Funktion? Wo ist ein Hinweis zur Migration von alten Quelltexten zu finden?
Zweites Beispiel: die Platform-Treiber liefern beim "Probing" eine Referenz auf eine Struktur zurück, die auch für die Kompatibilitätstabelle verwendet wird. Logischerweise könnte man mangels Dokumentation annehmen, daß diese Referenz einfach auf den passenden Tabelleneintrag verweist! Leider eine Fehlannahme....
Summa summarum: da es durchaus Entwickler gibt, die nur gelegentlich mit Treibern zu tun haben und somit nicht pausenlos die "Kernel-Mailinglisten" mitverfolgen wäre es doch schön, auch mal für eine brauchbar, netzpublizierte Dokumentation zu sorgen.
Perforce, waren das nicht diejenigen, die, Linus zur "git" Neu Entwicklung erzwungen haben?
Das wäre das einzige, was mir dazu einfällt...
Jojo
Das war BitMover mit dem Programm BitKeeper.
jupp, man werd ich aaaalt.
Jojo
we hope that this will continue "for ALL the time" !
roger
Die Dokumentation zählt nicht gerade zu den Glanzpunkten des Kernels. Viele andere quelloffenen Projekte beweisen, daß es durchaus auch anders geht.
Gerade mit Hilfsprogrammen wie Doxygen lassen sich gute Schnittstellendokumentationen im HTML-Format erzeugen, die folgende Anforderungen befriedigen
+ übersichtliche Darstellung auch der Datenrichtung und der gedachten Absicht (sowie Möglichkeit zur Plazierung von Beispielen).
+ Verwendbarkeit im Internet
+ Leicht verwendbare (klickbare) Querbezüge (ein Klick und ich weiß was of_platform ist).
Ich weiß nicht, ob die Intention der Kernelentwickler in einer Zukunftssicherung als Buchautoren zu suchen ist - aber bei den vielen schlecht dokumentierten Funktionen und gerade den API-Änderungen kommt einem dieser Verdacht schon auf.
Zwei Beispiele: ein etwas älterer Treiber verwendet die Struktur of_device - die Netzsuche erbrachte Andeutungen, daß diese gegen of_platform getauscht worden wäre. Wunderbar. Wo finde ich die Beschreibung der alten und der neuen Funktion? Wo ist ein Hinweis zur Migration von alten Quelltexten zu finden?
Zweites Beispiel: die Platform-Treiber liefern beim "Probing" eine Referenz auf eine Struktur zurück, die auch für die Kompatibilitätstabelle verwendet wird. Logischerweise könnte man mangels Dokumentation annehmen, daß diese Referenz einfach auf den passenden Tabelleneintrag verweist! Leider eine Fehlannahme....
Summa summarum: da es durchaus Entwickler gibt, die nur gelegentlich mit Treibern zu tun haben und somit nicht pausenlos die "Kernel-Mailinglisten" mitverfolgen wäre es doch schön, auch mal für eine brauchbar, netzpublizierte Dokumentation zu sorgen.