diff options
Diffstat (limited to 'README-hacking')
-rw-r--r-- | README-hacking | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/README-hacking b/README-hacking index 74cb866..7037357 100644 --- a/README-hacking +++ b/README-hacking | |||
@@ -39,45 +39,49 @@ which are extracted from other source packages: | |||
39 | cd dico | 39 | cd dico |
40 | 40 | ||
41 | 2. Run | 41 | 2. Run |
42 | 42 | ||
43 | ./bootstrap | 43 | ./bootstrap |
44 | 44 | ||
45 | Use one or more --verbose options to see details about its progress. | ||
46 | |||
45 | Once done, proceed as described in the file README (section | 47 | Once done, proceed as described in the file README (section |
46 | INSTALLATION). | 48 | INSTALLATION). |
47 | 49 | ||
48 | Normally you will have to run bootstrap only once. However, if you | ||
49 | intend to hack on Dico, you might need to run it again later. In | ||
50 | this case, you will probably want to save some time and bandwidth by | ||
51 | avoiding downloading the same files again. If so, create in the project's | ||
52 | root directory a file named `.bootstrap' with the following | ||
53 | contents: | ||
54 | |||
55 | --gnulib-srcdir=$HOME/gnulib | ||
56 | |||
57 | Replace `$HOME/gnulib' with the actual directory where the Gnulib | ||
58 | sources reside. | ||
59 | |||
60 | For more information about `bootstrap', run `bootstrap --help'. | 50 | For more information about `bootstrap', run `bootstrap --help'. |
61 | 51 | ||
62 | * Debugging | 52 | * Debugging |
63 | 53 | ||
64 | To debug dictd, use the following command: | 54 | To debug dicod, use the following command: |
65 | 55 | ||
66 | libtool --mode execute gdb dictd | 56 | libtool --mode execute gdb dicod |
67 | 57 | ||
68 | For debugging from Emacs run: | 58 | For debugging from Emacs run: |
69 | 59 | ||
70 | M-x gdb RET gud-wrapper dictd RET | 60 | M-x gdb RET gud-wrapper dicod RET |
71 | 61 | ||
72 | (the script gud-wrapper is located in the ./utils subdirectory) | 62 | (the script gud-wrapper is located in the ./utils subdirectory) |
73 | 63 | ||
64 | * Adding new modules | ||
65 | |||
66 | If you want to add a new module to Dico (e.g. named `foo'), run the | ||
67 | following command from the Dico source tree topmost directory: | ||
68 | |||
69 | ./bootstrap --add foo | ||
70 | |||
71 | This will create the directory modules/foo, populate it with the | ||
72 | necessary files, and add the appropriate statements to configure.ac | ||
73 | and modules/Makefile.am files. | ||
74 | |||
75 | After running this command, change to the modules/foo directory and | ||
76 | start hacking on your new module. | ||
77 | |||
74 | 78 | ||
75 | * Copyright information | 79 | * Copyright information |
76 | 80 | ||
77 | Copyright (C) 2008, 2010, 2012 Sergey Poznyakoff | 81 | Copyright (C) 2008, 2010, 2012, 2016 Sergey Poznyakoff |
78 | 82 | ||
79 | Permission is granted to anyone to make or distribute verbatim copies | 83 | Permission is granted to anyone to make or distribute verbatim copies |
80 | of this document as received, in any medium, provided that the | 84 | of this document as received, in any medium, provided that the |
81 | copyright notice and this permission notice are preserved, | 85 | copyright notice and this permission notice are preserved, |
82 | thus giving the recipient permission to redistribute in turn. | 86 | thus giving the recipient permission to redistribute in turn. |
83 | 87 | ||