soc-tools: Update README.md install section

Document some more of the dependencies.

Signed-off-by: Linus Walleij <linusw@kernel.org>
1 file changed
tree: 9896c166b609f84996566f9bdd34e797527d327f
  1. document-merges.sh
  2. git-hooks-post-commit
  3. git-hooks-post-merge
  4. install.sh
  5. LICENSE
  6. pw-review-soc.sh
  7. README.md
  8. verify_b4.sh
  9. verify_fixes.sh
  10. verify_sanity.sh
  11. verify_signedoff.sh
README.md

SoC Linux kernel maintainers group's tools for their workflow

Example workflow

git checkout soc/dt
soc-tools/pw-review-soc.sh

...

git fetch PULL_URL
git checkout -b FOO/dt32 FETCH_HEAD
git checkout -b FOO/dt64 FETCH_HEAD
git checkout -b FOO/drivers FETCH_HEAD

next-analysis/hist-pre-merge.sh origin/master..FETCH_HEAD

git checkout soc/dt
git rebase origin/soc/dt
git pull --log --signoff PULL_URL

... do some testing ...

git checkout for-next
git merge soc/dt
soc-tools/document-merges.sh
vi arch/arm/arm-soc-for-next-contents.txt
git add -p arch/arm/arm-soc-for-next-contents.txt && git commit --signoff -m "soc: document merges"
git push origin for-next soc/dt

Installation

  1. Clone the SoC kernel tree using SSH so you get an authenticated and writeable origin: git clone ssh://git@gitolite.kernel.org/pub/scm/linux/kernel/git/soc/soc.git

  2. Clone soc-tools: git clone git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc-tools.git

  3. Clone next-analysis: git clone https://github.com/krzk/next-analysis.git

  4. Go to the “soc” Linux kernel repository.

  5. Link the tool trees into your source tree for convenience: ln -s /path/to/soc-tools soc-tools ln -s /path/to/next-analysis next-analysis

  6. soc-tools/install.sh to install the git hooks

  7. Install tools used by the maintainer scripts: pipx install --user pwclient apt-get install / dnf -y mutt

  8. Put the required configuration into $HOME/.pwclientrc something like: --------8<----------8<--------- [options] default = linux-soc

    [linux-soc] backend = rest url = https://patchwork.kernel.org/api/1.2/ project = linux-soc token = 123456789abcdef... --------8<----------8<--------- The token is obtained from the kernel.org patchwork web UI, righ hand user drop-down, “View profile”, “Authentication” shows the API token for your user.

  9. In addition to this you need build scripts to build each target SoC architecture for testing. People use different things and different compilers (GCC or LLVM/Clang).

Uninstallation

  1. Go to the “soc” Linux kernel repository.
  2. rm -f .git/hooks/post-commit .git/hooks/post-applypatch .git/hooks/post-merge

next-analysis from: https://github.com/krzk/next-analysis