AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Don't mix external downloads with checked-in project source

Aperta
#1,386 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Build Issue Needs Discussion
Lingua principale
C++
Stelle
2.1k
Fork
503
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

When certain dependencies aren't found, OCIO's build scripts will download and build them automatically. (Yay!)

But then these files are left around intermixed with source, in the ext/ directory (which also contains sampleicc that is part of the OCIO repo). This is really inconvenient for several reasons: After a build, you have some things in ext that are part of the OCIO source repo, but other things that are NOT. You can't easily get rid of the temporarily downloads with `rm -rf ext`, and also you have to be super careful with `git commit -a` lest you accidentally sweep up those external projects along with whatever you are intentionally changing in OCIO's code.

I would suggest considering some subset of the following grab-bag of ideas to help address this:

* Have one subdirectory for external projects that are purposely embedded in the OCIO repo (like sampleicc), and a *separate* area for things you download but do not wish to become part of the OCIO project. Make sure you can easily `rm -r` the temp downloads just as easily and harmlessly as you can blow away the "build" and "dist" areas.

* Change the build scripts to put the downloads and source of the auto-build external packages in the "build" area, so it's not intermixed anywhere near the source.

* Add to `.gitignore` all the things that might be temporary downloads, so that a `git commit -a` can't possibly sweep them up, and even a `git status` isn't all cluttered with things that aren't part of the project.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando gli script di build che scaricano le dipendenze e la struttura attuale di ext/, quindi esamina .gitignore. Definisci una separazione netta tra i progetti inclusi nel repository, come sampleicc, e i download temporanei, con una posizione che possa essere rimossa in sicurezza. Il lavoro è completato quando le sorgenti esterne generate non si mescolano più con il codice sorgente del progetto e non ingombrano git status.

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

Valutazione

Stack tecnologico
git
Ambito
build-system
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.