bazelbuild/bazel

Documentation genrule example - maybe avoid $(location ..) or $(locations ..)

Open

#15.078 geöffnet am 18. März 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (4.465 Forks)batch import
P3help wantedteam-Documentationteam-Rules-Servertype: documentation (cleanup)

Repository-Metriken

Stars
 (25.384 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 22T 20h) (77 gemergte PRs in 30 T)

Beschreibung

Description of the problem / feature request:

https://docs.bazel.build/versions/main/be/general.html#genrule_examples

Elsewhere I've seen that we're not supposed to be using $(location) calls and should instead be using $(rootpath ..) or $(execpath ..)

https://github.com/bazelbuild/bazel/issues/2475#issuecomment-339318016

I just spent hours debugging why a genrule of mine didn't work, when it wasn't exactly clear from the example that

  1. We shouldn't be using $(location ..)
  2. That $(location ..) can return different things in Skylark depending on srcs vs other generated outs.

Maybe this is clear for people who've been in Bazel for years and are aware of the changes to all make-style vars.

Contributor Guide

Research-Richtung
Das Problem fordert die Aktualisierung der genrule Beispiele unter https://docs.bazel.build/versions/main/be/general.html#genrule examples, um $(rootpath) oder $(execpath) anstelle von $(location) zu verwenden, unter Bezugnahme auf eine frühere Diskussion. Es gibt keine Kommentare oder PRs. Die Korrektur umfasst die Bearbeitung der Dokumentationsdatei für genrule Beispiele, um $(location) Aufrufe zu ersetzen und einen Hinweis zur Veraltung hinzuzufügen.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
basic Bazel understanding
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85