portugalfuturista/elixir
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

REAMDE.md: fix formating

Browse source 
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
This commit is contained in:
Michael Opdenacker 2019-09-23 20:15:09 +02:00
parent 65783e715a
commit ee48545b9f
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -27,7 +27,7 @@ Installation
See the "Building Docker images" paragraph for building ready-made Docker
images. For a manual installation, you can read the Docker files in
the "docker/" directory to know what packages Elixir needs in your
the `docker/` directory to know what packages Elixir needs in your
favorite distribution.
Elixir has the following architecture:
@ -40,11 +40,11 @@ Elixir has the following architecture:
| Shell script |
'--------------------------------'
The shell script ("script.sh") is the lower layer and provides commands
The shell script (`script.sh`) is the lower layer and provides commands
to interact with Git and other Unix utilities. The Python commands use
the shell script's services to provide access to the annotated source
code and identifier lists ("query.py") or to create and update the
databases ("update.py"). Finally, the CGI interface ("web.py") uses the
code and identifier lists (`query.py`) or to create and update the
databases (`update.py`). Finally, the CGI interface (`web.py`) uses the
query interface to generate HTML pages.
When installing the system, you should test each layer manually and make
@ -76,9 +76,9 @@ For that reason, you may want to tweak the script (for example, by
limiting the number of tags with a "head") in order to test the
update and query commands.
The CGI interface ("web.py") is meant to be called from your web
The CGI interface (`web.py`) is meant to be called from your web
server. Since it includes support for indexing multiple projects,
it expects a different variable ("LXR_PROJ_DIR") which points to a
it expects a different variable (`LXR_PROJ_DIR`) which points to a
directory with a specific structure:
* <LXR_PROJ_DIR>
@ -121,7 +121,7 @@ Don't forget to enable cgi and rewrite support with `a2enmod cgi rewrite`.
Database design
---------------
"./update.py" stores a bidirectionnal mapping between git object hashes ("blobs") and a sequential key.
`./update.py` stores a bidirectionnal mapping between git object hashes ("blobs") and a sequential key.
The goal of indexing such hashes is to reduce their storage footprint (20 bytes for a SHA-1 hash
versus 4 bytes for a 32 bit integer).
@ -130,14 +130,14 @@ A detailed diagram of the databases will be provided. Until then, just use the S
Building Docker images
----------------------
Docker files are provided in the "docker/" directory. To generate your own
Docker files are provided in the `docker/` directory. To generate your own
Docker image for indexing the sources of a project (for example for the Musl
project which is much faster to index that Linux), download the "Dockerfile"
project which is much faster to index that Linux), download the `Dockerfile`
file for your target distribution and run:
$ docker build -t elixir --build-arg GIT_REPO_URL=git://git.musl-libc.org/musl --build-arg PROJECT=musl .
Then you can use your new container as follows (you get the container id from the output of "docker build"):
Then you can use your new container as follows (you get the container id from the output of `docker build`):
$ docker run <container-id>