Documentation improvements and some code clarifications

Open
#68 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
git, github, shell

Research direction

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.

Written by the indexing model from the issue text.

Description

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

Dominant language
Shell
Stars
130
Forks
56
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from raspberrypi/pico-setup

All issues in raspberrypi/pico-setup

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.