aboutsummaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2020-01-19 22:42:24 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2020-01-19 22:58:48 +0000
commit8cfc728ecfb81775fd7bcfde887d1fccc4e4e8ad (patch)
treedb351e3575085ab10933401bf8c3c679d9d38815 /README-hacking.md
parent0ccea404bf994525a6f42ccea8ed7e325660627a (diff)
New --check-config option to ./project to check software build status
Until now, it was necessry to run a long `while true' loop to see what is currently being built at configure time. So with this commit, a new `--checkconfig' option has been added to `./project' that can be called to run that loop and make it easier to check.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md45
1 files changed, 14 insertions, 31 deletions
diff --git a/README-hacking.md b/README-hacking.md
index 241f2dc..91846ea 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -556,20 +556,22 @@ First custom commit
- **Prepare to build project**: The `./project configure` command of the
next step will build the different software packages within the
- "build" directory (that you will specify), nothing else on your system
- will be touched. But since it takes long, it is useful to see what it
- is building at every instant (its almost impossible to tell from the
- torrent of commands that are produced!). So open another terminal on
- your desktop and navigate to the same project directory that you
- cloned (output of last command above). Then run the following
- command. It will just print the date, once every second. But as soon
- as the next step starts building software, you'll see the names of
- software come while they are being built, and go once they are
- installed in the project build directory (again: don't worry, nothing
- will be installed outside the build directory).
+ "build" directory (that you will specify). Nothing else on your system
+ will be touched. However, since it takes long, it is useful to see
+ what it is being built at every instant (its almost impossible to tell
+ from the torrent of commands that are produced!). So open another
+ terminal on your desktop and navigate to the same project directory
+ that you cloned (output of last command above). Then run the following
+ command. Once every second, this command will just print the date
+ (possibly followed by a non-existant directory notice). But as soon as
+ the next step starts building software, you'll see the names of
+ software get printed as they are being built. Once any software is
+ installed in the project build directory it will be removed. Again,
+ don't worry, nothing will be installed outside the build directory.
```shell
- $ while true; do echo; date; ls .build/software/build-tmp; sleep 1; done
+ # On another terminal (go to top project directory)
+ $ project --check-config
```
- **Test the template**: Before making any changes, it is important to
@@ -1236,25 +1238,6 @@ for the benefit of others.
$ git clone my-project-git.bundle
```
- - **Inspecting software building status**: When you run `./project
- configure`, several programs and libraries start to get configured and
- build (in many cases, simultaneously). To understand the building
- process, or for debugging a strange situation, it is sometimes useful
- to know which programs are being built at every moment. To do this,
- you can look into the `.build/software/build-tmp` directory (from the
- top project directory). This temporary directory is only present while
- building the software. At every moment, it contains the unpacked
- source tarball directories of the all the packages that are being
- built. After a software is successfully installed in your project, it
- is removed from this directory. To automatically get a listing of this
- directory every second, you can run the command below (on another
- terminal while the software are being built). Press `CTRL-C` to stop
- it and return back to the command-line).
-
- ```shell
- $ while true; do echo; date; ls .build/software/build-tmp; sleep 1; done
- ```
-