Documentation improvements and some code clarifications

オープン
  • 何か問題がありますか？
#68 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
58/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
git, github, shell
領域
build-system, documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Shell
スター
130
フォーク
55
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

raspberrypi/pico-setup のほかの issue

raspberrypi/pico-setup の issue をすべて見る

似ている issue

Shell/Bash の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。