Kerneldokumentation schlecht geordnet?

[bullgard]

Hallo debianforum.de,
Ich habe den Eindruck, daß die Kerneldokumentation schlecht geordnet ist. Auch die Bezeichner der Ordner sind schlecht gewählt. Ich nehme als Beispiel die für die Kernelversion 4.5.
Warum gibt es im Verzeichnis /usr/share/doc/ im Verzeichnis /linux-doc-4.5/ noch einmal ein Verzeichnis /Documentation/ ? »doc« und »Documentation« stehen ja wohl beide für den Begriff »Dokumentation«.
Das Verzeichnis /usr/share/doc/linux-doc-4.5/ enthält im wesentlichen zwei Verzeichnisse: /Documentation/ und /html/. Was spricht dafür, das Verzeichnis /linux-doc-4.5/ in diese zwei Verzeichnisse aufzuteilen? Was spricht für die farblose Namensgebung »/html/«? Da weiß der Leser mit Sicherheit nicht, über welches Fachgebiet geschrieben wird.
Mit freundlichen Grüßen
bullgard

[hikaru]

In /usr/share/doc/linux-doc-*/Documentation findest du gz-Archive, meist von einfachen Textdateien, in /usr/share/doc/linux-doc-*/html stehen unkomprimierte html-Dateien.
Die Trennung ist nicht inhaltsbasiert, sondern formatbasiert und als solche passend, wenn auch nicht in jedem Einzelfall ganz konsequent. Die Benennung des Unterverzeichnisses Documentation ist vermutlich historisch bedingt und seine Existenz ergibt Sinn, um die tatsächliche Dokumentation von den Metadaten, wie Copyright und Readme zu trennen.

[bullgard]

Hallo hikaru,

In /usr/share/doc/linux-doc-*/Documentation findest du gz-Archive, meist von einfachen Textdateien, in /usr/share/doc/linux-doc-*/html stehen unkomprimierte html-Dateien.
Die Trennung ist nicht inhaltsbasiert, sondern formatbasiert und als solche passend,….

Wieso ist das passend? Sie wird in anderen EDV-Dokumentationen in der Regel auch nicht vorgenommen. Sie hat den Nachteil, daß der Benutzer in zwei Verzeichnissen suchen muß.

Die Benennung des Unterverzeichnisses Documentation ist vermutlich historisch bedingt und seine Existenz ergibt Sinn, um die tatsächliche Dokumentation von den Metadaten, wie Copyright und Readme zu trennen.

Das sehe ich ähnlich. Es wäre aber mittlerweile an der Zeit, eine treffendere Bezeichnung zu finden und zu benutzen.
Gruß
bullgard

[hikaru]

Wieso ist das passend? Sie wird in anderen EDV-Dokumentationen in der Regel auch nicht vorgenommen.

Was andere Projekte machen ist nicht ausschlaggebend dafür ob etwas passend ist oder nicht.
Die Trennung folgt einer gewissen Logik, und zu dieser Logik passt die Struktur.

Sie hat den Nachteil, daß der Benutzer in zwei Verzeichnissen suchen muß.

... aber den Vorteil, dass man sich beim Betrachten nicht um Formate kümmern muss.
Wenn ich mir die Dokumentation mit einem Textbetrachter anschauen will, dann muss ich nicht die dann fast unleserlichen HTML-Dokumente filtern. Möchte ich einen Webbrowser nutzen, dann kann ich in jedem Dokument die erweiterten Funktionalitäten von HTML nutzen, wie z.B. Links zu anderen Dokumenten.

Es wäre aber mittlerweile an der Zeit, eine treffendere Bezeichnung zu finden und zu benutzen.

Könnte man machen, aber dann müsste man an irgendeinem Zeitpunkt einen Strukturbruch einbauen. Jeder der steinalte Programme nutzt, die sich auf die aktuelle Struktur verlassen müsste diese dann anpassen. Das könnte man abfedern, indem man alte und neue Struktur eine Zeit lang parallel anbietet, aber das Grundproblem bliebe bestehen.
Man muss also abwägen ob die Vorteile einer klareren Struktur die Nachteile des Strukturbruchs aufwiegen. Und oftmals scheitert die beste Lösung gerade daran, dass es bereits eine Lösung gibt, die gut genug ist.