Documentation improvements and some code clarifications
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
- Domain
- build-system, documentation
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-lfsfrom 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 1and--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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from raspberrypi/pico-setup
-
Recommended way to install the toolchain -- pico-setup or pico-sdk-tools installer?Possibly taken @will-v-pi claimed this 22 days ago. Open
Difficulty 5/5 Over a week Newbie friendliness 30/100
raspberrypi/pico-setup#70 · 5 comments · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
raspberrypi/pico-setup#67 · 1 reaction ·
-
Please write environment variable configuration to ~/.pam_environent and ~/.profile, or /etc/profile.d instead of ~/.bashrcPossibly taken @lurch claimed this 2091 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 25/100
raspberrypi/pico-setup#13 · 7 comments · 1 reaction ·
-
setup fails if $HOME/.bashrc does not have a new line at the end of the filePossibly taken @michaelstoops claimed this 2055 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
raspberrypi/pico-setup#12 · 8 comments ·
-
If pico_setup.sh fails during install it can't be re-runPossibly taken @ndabas claimed this 2115 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 20/100
raspberrypi/pico-setup#10 · 5 comments ·
All issues in raspberrypi/pico-setup
Similar issues
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
varnish/helm-varnish#173 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
command: update-lgsm distro: Debian engine: source2 game: Counter-Strike 2 regression: yes reproducible: always severity: low type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
GameServerManagers/LinuxGSM#5242 ·
Maintainers usually reply within 1 day
-
📦 Update Request
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
cdnjs/packages#2225 · 1 comment ·
Maintainers usually reply within 3 days