gem5-src: document saner defaults

This commit is contained in:
Ciro Santilli 六四事件 法轮功
2018-09-26 00:00:00 +00:00
parent 62a91e5583
commit 9f2cd88e48
2 changed files with 6 additions and 9 deletions

1
.gitignore vendored
View File

@@ -17,6 +17,7 @@ gitignore*
__pycache__ __pycache__
# Accidents. # Accidents.
/core
/m5out /m5out
*.o *.o
*.out *.out

View File

@@ -10679,22 +10679,18 @@ Next, when you want to build with this repository, use the `--gem5-src` argument
.... ....
cd linux-kernel-module-cheat cd linux-kernel-module-cheat
./build-gem5 \ ./build-gem5 \
--gem5-build-id p/lkmc/master \ --gem5-build-id p/master \
--gem5-src "$gem5_internal" \ --gem5-src "$gem5_internal" \
--gem5-worktree p/lkmc/master \ --gem5-worktree p/master \
; ;
./run-gem5 ./run-gem5
--gem5-build-id p/lkmc/master \ --gem5-build-id p/master \
--gem5-src "$gem5_internal" \ --gem5-src "$gem5_internal" \
--gem5-worktree p/lkmc/master \ --gem5-worktree p/master \
; ;
.... ....
`p/lkmc/` is not mandatory but it provides a sane default: `p` stands for Private, and is not mandatory, but it is a sane default that will remind you at all times that you are dealing with private code instead of public.
* `p` stands for `private`, and will separate the private from public builds
* `lkmc` is added to prevent name conflicts with other work-trees of the private repository
* `master`, finally, reflects that the worktree is at the `master` state of private repository
This setup only creates gitignored worktrees of the private repository inside this repository, which is pretty safe, while still allowing fully use our infrastructure as usual. This setup only creates gitignored worktrees of the private repository inside this repository, which is pretty safe, while still allowing fully use our infrastructure as usual.