Documentation improvements and some code clarifications

Aperta
  • Qualcosa non va?
#68 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
58/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
git, github, shell
Ambito
build-system, documentation

Direzione di ricerca

Start by locating the setup documentation section titled “Basic Setup on Other Operating Systems” and the script loop that clones picotool and debugprobe. Check the dependency instructions and branch selection against the current repositories, then review how shallow clones affect the build. Done means the documentation and clone behavior match the project's intended setup; the issue does not name files or tests.

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

Descrizione

I am trying to adapt this script to work on my personnal machine, this is a small report on some of the things that i found during this exercise (mainly documentation and some code nitpicking). Feel free to close this if it is not relevant for you.

  • It seems that #60 removed git-lfs from the dependencies. I suggest updating the documentation to reflect that:
> Under:
## Basic Setup on Other Operating Systems
### Prerequisites
#### Linux
then you can manually install the `GIT_DEPS` (`git` & `git-lfs`) and `SDK_DEPS` ...
  • This conditionnal doesn't seem to do anything since on the public facing github, both default branches for picotool and debugbrobe point to master (Another story if you use your own private servers for developping ...):
# NOTE: SDK_BRANCH="master" on `line 47`

for REPO in picotool debugprobe
do
    DEST="$OUTDIR/$REPO"
    REPO_URL="${GITHUB_PREFIX}${REPO}${GITHUB_SUFFIX}"

    # NOTE: Here !!!
    if [[ "$REPO" == "picotool" ]]; then
      git clone -b $SDK_BRANCH $REPO_URL # < Both branches point to master
    else
      git clone $REPO_URL
    fi
  • Since we are cloning repositories to build from source and not actively doing developpement work on them, i suggest saving disk space by doing shallow clones of the repositories (using --depth 1 and --shallow-submodules)

Thank you for your attention

Lingua principale
Shell
Stelle
130
Fork
55
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 raspberrypi/pico-setup

Tutte le issue di raspberrypi/pico-setup

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.