Have more complete examples in the directive docs

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#2,210 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
66/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Lies die Direktiven-Dokumentation mit den Beispielen für kind:autotools und vergleiche sie mit dem Beispiel im Issue. Ergänze ein ausführlicheres Beispiel, das configure-commands als Standardwert, das Voranstellen eines Befehls und die von BuildStream geladenen resultierenden Befehle zeigt. Die Aufgabe ist erledigt, wenn Leser diese drei Schritte in der Direktiven-Dokumentation klar erkennen können.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

While reviewing this it has reminded me, for these examples, I have always wanted something like below to help readers understand these features better.

An element using kind:autotools will have the following default behaviour from the plugin:

config:
  configure-commands:
  - |
    %{autogen}
  - |
    %{configure}

In the element, additional configure-commands can be set before the default ones like this:

kind:autotools
**snip**
config:
 configure-commands:
   (<):
     # Before configuring, lets make sure we're using
     # the latest config.sub & config.guess
     - cp %{datadir}/automake-*/config.{sub,guess} .
**snip**

which will result in the following being loaded and built by Buildstream:

kind:autotools
**snip**
config:
 configure-commands:
  # Before configuring, lets make sure we're using
  # the latest config.sub & config.guess
  - cp %{datadir}/automake-*/config.{sub,guess} .
  - |
    %{autogen}
  - |
    %{configure}
**snip**

but this is probably out of scope for this PR, so I'll open up a follow-up issue.

Originally posted by @nathanwilliams-ct in #2202

Vorherrschende Sprache
Python
Sterne
156
Forks
53
Ø Merge
8 T. 9 Std.
Gemergte PRs (30 T.)
13

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus apache/buildstream

Alle Issues in apache/buildstream

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

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