xref: /Universal-ctags/gnulib/README.md (revision 7f22520a348fda0ea428a13afe40ab03b1a6ffc7)
1*7f22520aSHiroo HAYASHI# README for `gnulib/` directory
2*7f22520aSHiroo HAYASHI
3*7f22520aSHiroo HAYASHIThe files in this directory were taken from [the GNU Portability Library
4*7f22520aSHiroo HAYASHI(Gnulib)](https://www.gnu.org/software/gnulib/).
5*7f22520aSHiroo HAYASHI
6*7f22520aSHiroo HAYASHISee "1. Bread Overview" and "3. Invoking gnulib-tool" in [the GNU Gnulib
7*7f22520aSHiroo HAYASHIdocuments](https://www.gnu.org/software/gnulib/manual/gnulib.html) for more details.
8*7f22520aSHiroo HAYASHI
9*7f22520aSHiroo HAYASHI## Checking out Gnulib
10*7f22520aSHiroo HAYASHI
11*7f22520aSHiroo HAYASHI```
12*7f22520aSHiroo HAYASHI$ git clone git://git.sv.gnu.org/gnulib.git
13*7f22520aSHiroo HAYASHI```
14*7f22520aSHiroo HAYASHI
15*7f22520aSHiroo HAYASHIIn the following description, the directory where Gnulib is checked out is
16*7f22520aSHiroo HAYASHIcalled `$GNULIB_DIR`. And the root directory of the Universal Ctags is called
17*7f22520aSHiroo HAYASHI`$CTAGS_DIR`.
18*7f22520aSHiroo HAYASHI
19*7f22520aSHiroo HAYASHI## Importing the first module
20*7f22520aSHiroo HAYASHI
21*7f22520aSHiroo HAYASHIThe first module (`regex`) was imported by the following command into the
22*7f22520aSHiroo HAYASHIdirectory `gnulib/` without modifying `.gitignore`.
23*7f22520aSHiroo HAYASHI
24*7f22520aSHiroo HAYASHI```
25*7f22520aSHiroo HAYASHI$ cd $CTAGS_DIR
26*7f22520aSHiroo HAYASHI$ gnulib-tool --source-base=gnulib --no-vc-files --import regex
27*7f22520aSHiroo HAYASHI```
28*7f22520aSHiroo HAYASHI
29*7f22520aSHiroo HAYASHIThe options used are saved in `m4/gnulib-cache.m4`.
30*7f22520aSHiroo HAYASHI
31*7f22520aSHiroo HAYASHI## Updating the modules
32*7f22520aSHiroo HAYASHI
33*7f22520aSHiroo HAYASHI`-add-import` without module names updates imported modules.
34*7f22520aSHiroo HAYASHI
35*7f22520aSHiroo HAYASHI```
36*7f22520aSHiroo HAYASHI$ cd $GNULIB_DIR
37*7f22520aSHiroo HAYASHI$ git pull
38*7f22520aSHiroo HAYASHI$ cd $CTAGS_DIR
39*7f22520aSHiroo HAYASHI$ gnulib-tool --add-import
40*7f22520aSHiroo HAYASHI```
41*7f22520aSHiroo HAYASHI
42*7f22520aSHiroo HAYASHI## Importing additional modules
43*7f22520aSHiroo HAYASHI
44*7f22520aSHiroo HAYASHI```
45*7f22520aSHiroo HAYASHI$ gnulib-tool --add-import foo bar ...
46*7f22520aSHiroo HAYASHI```
47