nushell / nushell/nushell.github.io

Status of dependencies unclear

Offen
#823 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
258
Forks
561
Ø Merge
3 Std. 20 Min.
Gemergte PRs (30 T.)
15

Beschreibung

I think the dependencies section of the docs needs some help. Somebody recently pointed out that "libx11 is no longer required" with a link to some commit where it was dropped, but the docs are not clear on this subject.

https://github.com/nushell/nushell.github.io/blob/343ee0ad909630ca1cf87dc20a24f8fc75b21d9e/book/installation.md?plain=1#L51-L69

This section leaves me (as a distro packager for Arch Linuk) with more questions than answers. Why are X11 and XCB libs required on RedHat based distros but not Debian based? Is pkg-config a run time dependency or a build time dependencies? Why does some packaging list curl and bzip2 as dependencies, were these once dependencies now removed, or just undocumented, or just packaging mistakes? Why does macOS need cmake but not other platforms? Experimentally nushell seems to build without XCB or X11 libs, and searching the code base suggests nothing about XCB is used any more.

Can somebody that actually knows clarify what is actually needed at build & run times now and document these as generic dependencies, then comment in the per-distro sections on why those lists vary (e.g. perhaps one was assuming Ubuntu has X11 installed, something that may be true for most workstations but not necessarily servers).

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit book/installation.md in der Umgebung der Zeilen 51–69 und sieh dir den referenzierten Commit an. Vergleiche die dokumentierten Abhängigkeitslisten pro Distribution und für macOS, unterscheide dabei zwischen Build-Zeit- und Laufzeitanforderungen und prüfe die Fragen des Issues zu X11, XCB, pkg-config, curl, bzip2 und cmake. Als erledigt gilt die Aufgabe, wenn die Dokumentation der allgemeinen und plattformspezifischen Abhängigkeiten die Unterschiede klar erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cmake, linux, macos
Bereich
build-system, documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.