Commit graph

43 commits

Author SHA1 Message Date
K
3d08d50c08
README: fix formatting for venv commands 2024-12-13 18:45:24 +03:00
Nathan Wang
5fe2a8eef1
Fix docker build command in README 2024-11-23 15:07:44 -08:00
Franciszek Stachura
6b47af27a7 README, Dockerfile: Update to support version in footer 2024-11-06 17:18:07 +01:00
Théo Lebrun
1853abe7f9 README: fix docker image instructions
Two issues are fixed:

 - Initial `docker build` instructions fail because the Dockerfile path
   is wrong (elixir/Dockerfile versus elixir/docker/Dockerfile).

 - Indexing instructions are wrong because they do not use the
   virtualenv Python. It contains the installed packages, which we need
   for indexing. Issue appears as:

      ModuleNotFoundError: No module named 'bsddb3' (edited)

We also remove some common Docker knowledge (why we might want the
database to be coming from a mounted volume, rather than stored inside
the container).

Finally, we fix line widths but splitting commands into multiple lines.

Signed-off-by: Théo Lebrun <theo.lebrun@bootlin.com>
2024-10-01 16:03:24 +02:00
Franciszek Stachura
214f606e07 README: update with information about WSGI version of Elixir
* Add changelog
2024-08-27 11:33:19 +02:00
Franciszek Stachura
3714430aef Remove 'HttpProtocolOptions Unsafe' apache.conf insertion from Dockerfile
* Also remove mention of 'HttpProtocolOptions Unsafe' from README
2024-08-05 15:15:57 +02:00
Franciszek Stachura
d6df6deeaa Add information about PYTHONUNBUFFERED env var to README
Without it update logs don't show up on docker run
2024-08-05 15:15:01 +02:00
Franciszek Stachura
ffe8d79c40 Simplify and refactor Dockerfile
* Remove repository indexing from Dockerfile
* Copy Elixir code from the context instead of cloning it from Github
* Move Dockerfile from docker/debian/Dockerfile to docker/Dockerfile
* Add docs for the new Dockerfile
* Add an utility script that allows easier repository configuration
* Add .dockerignore
* Use relative paths in Docker section in README
2024-08-05 14:54:03 +02:00
Michael Opdenacker
fc47224425 README.adoc: stop mentioning the removed CentOS Dockerfile
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-04-29 13:12:51 +02:00
Théo Lebrun
c8bcfc8306 docker: Fix debian/Dockerfile filepath and README doc
Two things get fixed here:

 - README says downloading Dockerfile is enough. It is not; Debian
   Dockerfile requires docker/debian/000-default.conf file.

 - docker/debian/Dockerfile links to 000-default.conf file using:

      COPY ./docker/debian/000-default.conf /etc/apache2/sites-available/000-default.conf

   This means following command in README cannot work:

      docker build [...] .

   Either you set cwd to root Git repo and Dockerfile is not found, or
   you set cwd to docker/debian/ and 000-default.conf is not found.
   Correct command would be:

      docker build -f docker/debian/Dockerfile [...] .

We fix Dockerfile by expecting 000-default.conf to be in cwd. We fix
README by rewording the paragraph and updating commands to work based
on Git repo root directory.

Signed-off-by: Théo Lebrun <theo.lebrun@bootlin.com>
2024-04-29 12:36:54 +02:00
Michael Opdenacker
1e3517f261 README.adoc: update infos about threads
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-05-05 16:21:30 +02:00
Michael Opdenacker
26a47b6111 Use git "bare" cloning in README.adoc and Dockerfile(s)
This saves storage space

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-05-05 10:27:00 +02:00
Michael Opdenacker
8ffb3d9599 README.adoc: special version of "universal-ctags" no longer required
Because required changes are now included in the official packages
(at least in Ubuntu 22.04)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-03-23 11:18:55 +01:00
Ziyue Pan
7c4886cf3c Style: fix redundant parentheses and typos
(cherry picked from commit cd89684ce633c4997b328395cc882de3ab655475)
2023-03-23 09:54:14 +01:00
Ziyue Pan
67562314e1 fix typo in README 2023-03-21 08:14:07 +01:00
Michael Opdenacker
5d4a8d4e5d README.adoc: now use upstream version of Pygments
No more need for a custom version, as our changes are now upstream.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-23 16:40:45 +01:00
anatasluo
514fa38ed8 README: add configure step for SELinux and systemd
To fix issues like #213, configure for SELinux
is necessary.

Signed-off-by: anatasluo <luolongjuna@gmail.com>
2022-05-19 09:42:44 +08:00
mlern
2c77af7895 Fix a misspelling with the path to store elixir-data 2020-09-27 11:08:11 -07:00
Maxime Chretien
f32b5b21f2 README: Update CentOS dependencies
Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-07-02 16:37:11 +02:00
Maxime Chretien
4cbc349b49 README: Update lighthttpd conf
Not tested but it should work

Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-06-11 15:13:05 +02:00
Maxime Chretien
086250fb03 web : Add autocompletion for ident search bar
To do that we use a slightly modified version of the script found here:
https://github.com/autocompletejs/autocomplete.js/tree/2.7
This code is under MIT licence so it's compatible with Elixir's licence

The server answers requests from the script via a new interface:
https://elixir.bootlin.com/acp?q=<query>&f=<family>&p=<project>

And this is handled by autocomplete.py
The script creates and uses a tmp file to store idents for each project
in order to reduce the time needed to answer a request.

Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-06-11 14:38:44 +02:00
Maxime Chretien
f1329027bd README: Add some informations
Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-06-08 15:56:02 +02:00
Maxime Chretien
acc02a4f14 README: Update default and min threads number
Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-06-08 15:37:59 +02:00
Michael Opdenacker
100ef94665
Merge pull request #152 from MaximeChretien/db-creation-speed
Update.py : Improve threading
2020-06-05 10:30:51 +02:00
Maxime Chretien
f6838a3889 README & scripts : Update for threads argument of update.py
Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-06-03 10:07:09 +02:00
Maxime Chretien
5626c39546 Add support for old Linux versions
This add support for linux 0.01 to 2.6.12-rc1

Some versions are missing like 0.02 to 0.10 (not included) but it looks like
they have been deleted over time.

Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-06-02 13:46:14 +02:00
Maxime Chretien
0fb351fc6b README: Update ctags link to refer to official repo
Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-05-27 10:21:33 +02:00
Michael Opdenacker
4c23138b32
Merge pull request #138 from MaximeChretien/ctags-upstream
script.sh: Adapt to universal-ctags Kconfig parser
2020-05-27 09:39:20 +02:00
Michael Opdenacker
26dea97750 v2.0 release
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2020-05-27 09:07:35 +02:00
Maxime Chretien
6d30f73935 README: Update ctags version number
Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-05-26 13:32:19 +02:00
Chris White
5e7cab18ca Added/updated copyright notices; whitespace fixes
No functional changes
2020-05-23 15:14:21 -04:00
Michael Opdenacker
d3ba0cea3b Documentation updates
- Mention to mark the universal-ctags modified package as "hold"

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2020-05-22 18:43:37 +02:00
Michael Opdenacker
cc3cdfa93c Add missing dependency for universal-ctags
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2020-05-22 18:31:26 +02:00
Maxime Chretien
410a7055b4 README: Add custom ctags informations and families support
Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-05-22 10:29:24 +02:00
Michael Opdenacker
99d5ef7c84 Fix minor typo in documentation
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2020-05-22 10:28:08 +02:00
Maxime Chretien
92aaafcd5d README: Update informations about pygments installation
The file has been updated to enable Kconfig highlighting for file with
names like Kconfig.x86, Kconfig.debug, Kconfig-nommu, ...

Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-05-20 12:14:34 +02:00
Michael Opdenacker
a73cfcc3d0 Add details about DTS syntax highlighting
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2020-04-24 15:47:31 +02:00
Maxime Chretien
2864ae1731 README: Update apache configuration
Allow apache to use encoded slashes

Signed-off-by: Maxime Chretien <maxime.chretien@bootlin.com>
2020-04-21 16:13:02 +02:00
Michael Opdenacker
24da3e66dd Improve REST API documentation
- Using "API" instead of "api"
- Putting the REST API doc in the right place in the document

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2020-04-21 11:30:24 +02:00
Michael Opdenacker
f597fce20d Add contribution guidelines
- Coding style
- How to send patches

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2020-04-21 09:47:12 +02:00
Carmeli Tamir
c9db61ccc2 Reordered sections 2020-04-18 11:12:02 -04:00
Carmeli Tamir
b3ec8a87a1 Added table of contents 2020-04-18 10:58:08 -04:00
Carmeli Tamir
a62164a95f Converted MD to AsciiDoc 2020-04-18 10:46:44 -04:00
Renamed from README.md (Browse further)