From 9f2cd88e4819b07678d493ebc6be3a19022e0b4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciro=20Santilli=20=E5=85=AD=E5=9B=9B=E4=BA=8B=E4=BB=B6=20?= =?UTF-8?q?=E6=B3=95=E8=BD=AE=E5=8A=9F?= Date: Wed, 26 Sep 2018 00:00:00 +0000 Subject: [PATCH] gem5-src: document saner defaults --- .gitignore | 1 + README.adoc | 14 +++++--------- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index a85d4a6..183375c 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ gitignore* __pycache__ # Accidents. +/core /m5out *.o *.out diff --git a/README.adoc b/README.adoc index eb2feb6..4bb067e 100644 --- a/README.adoc +++ b/README.adoc @@ -10679,22 +10679,18 @@ Next, when you want to build with this repository, use the `--gem5-src` argument .... cd linux-kernel-module-cheat ./build-gem5 \ - --gem5-build-id p/lkmc/master \ + --gem5-build-id p/master \ --gem5-src "$gem5_internal" \ - --gem5-worktree p/lkmc/master \ + --gem5-worktree p/master \ ; ./run-gem5 - --gem5-build-id p/lkmc/master \ + --gem5-build-id p/master \ --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 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 +`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. 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.