Renaming toplevel `src/` to `openroad/`

Aperta
  • Qualcosa non va?
#12,161 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
cmake, cpp, git, shell
Ambito
build-system, tooling

Direzione di ricerca

Start by reviewing the linked rename-src-to-openroad.sh script and its step 0, which describes the OpenSTA repository change; update that submodule before running the remaining steps in OpenROAD. Check the resulting project references and build, and confirm that the test/... directory still works. The issue describes a broad repository rename and notes that copybara imports and external scripts may also need updates.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Now that we are freed of cmake, we can start organizing the project more nicely.

One of the steps (unfortunately also pretty invasive) is to rename the toplevel src/ to openroad/. This will then make the switch to relative-to-project-root includes ( #10449 ) more readable (so instead of including "src/foo/bar/baz.h" we include "openroad/foo/bar/baz.h" - thus giving the toplevel name a meaning).

Since this is a lot of change, I'd like to not do this as a pull request, but have crafted as shell-script to be run over the project to do all necessary changes. I'll leave it to @maliberty to run and push.

rename-src-to-openroad.sh

There is a small change that also needs to be in the OpenRoad fork of OpenSTA; in the script, they are marked as 'step 0' and work directly in the repository, but in reality this should of course be done first in the OpenSTA repo,then the submodule updated, and then running all the rest of the script.

This is the first step of better project organization, but since it touches a lot, it is good to do early on, because follow-up changes are then smaller and can be done more locally.

FYI: @QuantamHD @mikesinouye : after this is applied, your copybara import script probably needs adaption
@oharboe The test/... directory still works afterwards, but there might be other scripts outside the repo that then might need changes.

AI disclaimer: most of the renaming and building a script from the necessary steps was created with Gemini.

Lingua principale
Verilog
Stelle
3.3k
Fork
1.1k
Merge medio
2g 14h
PR unite (30g)
277

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di The-OpenROAD-Project/OpenROAD

Tutte le issue di The-OpenROAD-Project/OpenROAD

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.