Merge ~danilogondolfo/netplan/+git/ubuntu:mantic_0_107_1_sru into ~ubuntu-core-dev/netplan/+git/ubuntu:ubuntu-mantic
- Git
- lp:~danilogondolfo/netplan/+git/ubuntu
- mantic_0_107_1_sru
- Merge into ubuntu-mantic
Proposed by
Danilo Egea Gondolfo
Status: | Merged | ||||
---|---|---|---|---|---|
Merged at revision: | a28328d79bc426adf65bc6026cb81174174072de | ||||
Proposed branch: | ~danilogondolfo/netplan/+git/ubuntu:mantic_0_107_1_sru | ||||
Merge into: | ~ubuntu-core-dev/netplan/+git/ubuntu:ubuntu-mantic | ||||
Diff against target: |
7418 lines (+4749/-562) 62 files modified
Doxyfile (+2688/-0) debian/changelog (+69/-0) debian/control (+2/-1) debian/extra/PLACEHOLDER (+4/-0) debian/netplan.io.preinst (+17/-0) debian/patches/0001-parse-nm-wg-append-the-correct-prefix-to-IPv6-addres.patch (+77/-0) debian/patches/0007-tests-assert-generated-.service-files-in-assert_srio.patch (+26/-0) debian/patches/0008-tests-sriov-test-if-the-generated-netplan-rebind-ser.patch (+57/-0) debian/patches/0009-sriov-don-t-generate-duplicate-entries-in-the-rebind.patch (+96/-0) debian/patches/lp2041727/0004-cli-utils-introduce-systemctl_is_installed-helper.patch (+63/-0) debian/patches/lp2041727/0005-Update-ovs.py-to-check-if-ovsdb-server.service-is-in.patch (+75/-0) debian/patches/series (+6/-11) debian/rules (+0/-4) debian/tests/prep-testbed.sh (+3/-0) dev/null (+0/-371) doc/apidoc/inc-netplan.md (+4/-0) doc/apidoc/inc-parse-nm.md (+4/-0) doc/apidoc/inc-parse.md (+4/-0) doc/apidoc/inc-types.md (+4/-0) doc/apidoc/inc-util.md (+4/-0) doc/apidoc/index.md (+52/-0) doc/conf.py (+29/-1) doc/contribute-docs.md (+26/-0) doc/howto.md (+1/-0) doc/netplan-everywhere.md (+54/-60) doc/netplan-yaml.md (+5/-3) doc/reference.md (+3/-3) doc/requirements.txt (+1/-0) doc/spelling_wordlist.txt (+36/-4) examples/bonding.yaml (+1/-0) examples/wpa3_enterprise.yaml (+26/-0) include/netplan.h (+4/-0) include/parse-nm.h (+4/-0) include/parse.h (+4/-0) include/types.h (+4/-0) include/util.h (+21/-0) netplan_cli/cli/commands/apply.py (+19/-1) netplan_cli/cli/commands/try_command.py (+1/-2) netplan_cli/cli/utils.py (+14/-0) src/abi.h (+14/-0) src/names.c (+4/-0) src/netplan.c (+7/-1) src/networkd.c (+77/-39) src/nm.c (+49/-6) src/parse-nm.c (+43/-6) src/parse.c (+76/-18) src/types-internal.h (+3/-0) src/types.c (+3/-1) src/util-internal.h (+3/-0) src/util.c (+10/-0) src/validation.c (+2/-4) tests/generator/test_auth.py (+5/-2) tests/generator/test_common.py (+88/-3) tests/generator/test_tunnels.py (+9/-12) tests/generator/test_wifis.py (+372/-8) tests/integration/ovs.py (+4/-1) tests/integration/regressions.py (+27/-0) tests/integration/routing.py (+1/-0) tests/integration/tunnels.py (+43/-0) tests/parser/test_keyfile.py (+370/-0) tests/test_libnetplan.py (+19/-0) tests/test_utils.py (+12/-0) |
||||
Related bugs: |
|
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Lukas Märdian | Approve | ||
Ubuntu Core Development Team | Pending | ||
Review via email:
|
Commit message
Description of the change
To post a comment you must log in.
Revision history for this message
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Lukas Märdian (slyon) wrote : | # |
We discussed the .preinst situation out-of-band and agreed that python3-netplan does not own any files in /usr/share/netplan, so should not touch those and the script should stay within the netplan.io binary.
Builds are looking good in https:/
Revision history for this message
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Danilo Egea Gondolfo (danilogondolfo) wrote : | # |
I also submitted the netplan.io.preinst script to Debian https:/
Revision history for this message
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Lukas Märdian (slyon) wrote : | # |
Update scan failed
At least one of the branches involved have failed to scan. You can manually schedule a rescan if required.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | diff --git a/Doxyfile b/Doxyfile | |||
2 | 0 | new file mode 100644 | 0 | new file mode 100644 |
3 | index 0000000..19db167 | |||
4 | --- /dev/null | |||
5 | +++ b/Doxyfile | |||
6 | @@ -0,0 +1,2688 @@ | |||
7 | 1 | # Doxyfile 1.9.4 | ||
8 | 2 | |||
9 | 3 | # This file describes the settings to be used by the documentation system | ||
10 | 4 | # doxygen (www.doxygen.org) for a project. | ||
11 | 5 | # | ||
12 | 6 | # All text after a double hash (##) is considered a comment and is placed in | ||
13 | 7 | # front of the TAG it is preceding. | ||
14 | 8 | # | ||
15 | 9 | # All text after a single hash (#) is considered a comment and will be ignored. | ||
16 | 10 | # The format is: | ||
17 | 11 | # TAG = value [value, ...] | ||
18 | 12 | # For lists, items can also be appended using: | ||
19 | 13 | # TAG += value [value, ...] | ||
20 | 14 | # Values that contain spaces should be placed between quotes (\" \"). | ||
21 | 15 | # | ||
22 | 16 | # Note: | ||
23 | 17 | # | ||
24 | 18 | # Use doxygen to compare the used configuration file with the template | ||
25 | 19 | # configuration file: | ||
26 | 20 | # doxygen -x [configFile] | ||
27 | 21 | # Use doxygen to compare the used configuration file with the template | ||
28 | 22 | # configuration file without replacing the environment variables: | ||
29 | 23 | # doxygen -x_noenv [configFile] | ||
30 | 24 | |||
31 | 25 | #--------------------------------------------------------------------------- | ||
32 | 26 | # Project related configuration options | ||
33 | 27 | #--------------------------------------------------------------------------- | ||
34 | 28 | |||
35 | 29 | # This tag specifies the encoding used for all characters in the configuration | ||
36 | 30 | # file that follow. The default is UTF-8 which is also the encoding used for all | ||
37 | 31 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the | ||
38 | 32 | # iconv built into libc) for the transcoding. See | ||
39 | 33 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. | ||
40 | 34 | # The default value is: UTF-8. | ||
41 | 35 | |||
42 | 36 | DOXYFILE_ENCODING = UTF-8 | ||
43 | 37 | |||
44 | 38 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by | ||
45 | 39 | # double-quotes, unless you are using Doxywizard) that should identify the | ||
46 | 40 | # project for which the documentation is generated. This name is used in the | ||
47 | 41 | # title of most generated pages and in a few other places. | ||
48 | 42 | # The default value is: My Project. | ||
49 | 43 | |||
50 | 44 | PROJECT_NAME = "Netplan" | ||
51 | 45 | |||
52 | 46 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This | ||
53 | 47 | # could be handy for archiving the generated documentation or if some version | ||
54 | 48 | # control system is used. | ||
55 | 49 | |||
56 | 50 | PROJECT_NUMBER = | ||
57 | 51 | |||
58 | 52 | # Using the PROJECT_BRIEF tag one can provide an optional one line description | ||
59 | 53 | # for a project that appears at the top of each page and should give viewer a | ||
60 | 54 | # quick idea about the purpose of the project. Keep the description short. | ||
61 | 55 | |||
62 | 56 | PROJECT_BRIEF = | ||
63 | 57 | |||
64 | 58 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included | ||
65 | 59 | # in the documentation. The maximum height of the logo should not exceed 55 | ||
66 | 60 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy | ||
67 | 61 | # the logo to the output directory. | ||
68 | 62 | |||
69 | 63 | PROJECT_LOGO = | ||
70 | 64 | |||
71 | 65 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path | ||
72 | 66 | # into which the generated documentation will be written. If a relative path is | ||
73 | 67 | # entered, it will be relative to the location where doxygen was started. If | ||
74 | 68 | # left blank the current directory will be used. | ||
75 | 69 | |||
76 | 70 | OUTPUT_DIRECTORY = | ||
77 | 71 | |||
78 | 72 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 | ||
79 | 73 | # sub-directories (in 2 levels) under the output directory of each output format | ||
80 | 74 | # and will distribute the generated files over these directories. Enabling this | ||
81 | 75 | # option can be useful when feeding doxygen a huge amount of source files, where | ||
82 | 76 | # putting all generated files in the same directory would otherwise causes | ||
83 | 77 | # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to | ||
84 | 78 | # control the number of sub-directories. | ||
85 | 79 | # The default value is: NO. | ||
86 | 80 | |||
87 | 81 | CREATE_SUBDIRS = NO | ||
88 | 82 | |||
89 | 83 | # Controls the number of sub-directories that will be created when | ||
90 | 84 | # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every | ||
91 | 85 | # level increment doubles the number of directories, resulting in 4096 | ||
92 | 86 | # directories at level 8 which is the default and also the maximum value. The | ||
93 | 87 | # sub-directories are organized in 2 levels, the first level always has a fixed | ||
94 | 88 | # numer of 16 directories. | ||
95 | 89 | # Minimum value: 0, maximum value: 8, default value: 8. | ||
96 | 90 | # This tag requires that the tag CREATE_SUBDIRS is set to YES. | ||
97 | 91 | |||
98 | 92 | CREATE_SUBDIRS_LEVEL = 8 | ||
99 | 93 | |||
100 | 94 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII | ||
101 | 95 | # characters to appear in the names of generated files. If set to NO, non-ASCII | ||
102 | 96 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode | ||
103 | 97 | # U+3044. | ||
104 | 98 | # The default value is: NO. | ||
105 | 99 | |||
106 | 100 | ALLOW_UNICODE_NAMES = NO | ||
107 | 101 | |||
108 | 102 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | ||
109 | 103 | # documentation generated by doxygen is written. Doxygen will use this | ||
110 | 104 | # information to generate all constant output in the proper language. | ||
111 | 105 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, | ||
112 | 106 | # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English | ||
113 | 107 | # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, | ||
114 | 108 | # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with | ||
115 | 109 | # English messages), Korean, Korean-en (Korean with English messages), Latvian, | ||
116 | 110 | # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, | ||
117 | 111 | # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, | ||
118 | 112 | # Swedish, Turkish, Ukrainian and Vietnamese. | ||
119 | 113 | # The default value is: English. | ||
120 | 114 | |||
121 | 115 | OUTPUT_LANGUAGE = English | ||
122 | 116 | |||
123 | 117 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member | ||
124 | 118 | # descriptions after the members that are listed in the file and class | ||
125 | 119 | # documentation (similar to Javadoc). Set to NO to disable this. | ||
126 | 120 | # The default value is: YES. | ||
127 | 121 | |||
128 | 122 | BRIEF_MEMBER_DESC = YES | ||
129 | 123 | |||
130 | 124 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief | ||
131 | 125 | # description of a member or function before the detailed description | ||
132 | 126 | # | ||
133 | 127 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | ||
134 | 128 | # brief descriptions will be completely suppressed. | ||
135 | 129 | # The default value is: YES. | ||
136 | 130 | |||
137 | 131 | REPEAT_BRIEF = YES | ||
138 | 132 | |||
139 | 133 | # This tag implements a quasi-intelligent brief description abbreviator that is | ||
140 | 134 | # used to form the text in various listings. Each string in this list, if found | ||
141 | 135 | # as the leading text of the brief description, will be stripped from the text | ||
142 | 136 | # and the result, after processing the whole list, is used as the annotated | ||
143 | 137 | # text. Otherwise, the brief description is used as-is. If left blank, the | ||
144 | 138 | # following values are used ($name is automatically replaced with the name of | ||
145 | 139 | # the entity):The $name class, The $name widget, The $name file, is, provides, | ||
146 | 140 | # specifies, contains, represents, a, an and the. | ||
147 | 141 | |||
148 | 142 | ABBREVIATE_BRIEF = "The $name class" \ | ||
149 | 143 | "The $name widget" \ | ||
150 | 144 | "The $name file" \ | ||
151 | 145 | is \ | ||
152 | 146 | provides \ | ||
153 | 147 | specifies \ | ||
154 | 148 | contains \ | ||
155 | 149 | represents \ | ||
156 | 150 | a \ | ||
157 | 151 | an \ | ||
158 | 152 | the | ||
159 | 153 | |||
160 | 154 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | ||
161 | 155 | # doxygen will generate a detailed section even if there is only a brief | ||
162 | 156 | # description. | ||
163 | 157 | # The default value is: NO. | ||
164 | 158 | |||
165 | 159 | ALWAYS_DETAILED_SEC = NO | ||
166 | 160 | |||
167 | 161 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all | ||
168 | 162 | # inherited members of a class in the documentation of that class as if those | ||
169 | 163 | # members were ordinary class members. Constructors, destructors and assignment | ||
170 | 164 | # operators of the base classes will not be shown. | ||
171 | 165 | # The default value is: NO. | ||
172 | 166 | |||
173 | 167 | INLINE_INHERITED_MEMB = NO | ||
174 | 168 | |||
175 | 169 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path | ||
176 | 170 | # before files name in the file list and in the header files. If set to NO the | ||
177 | 171 | # shortest path that makes the file name unique will be used | ||
178 | 172 | # The default value is: YES. | ||
179 | 173 | |||
180 | 174 | FULL_PATH_NAMES = YES | ||
181 | 175 | |||
182 | 176 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. | ||
183 | 177 | # Stripping is only done if one of the specified strings matches the left-hand | ||
184 | 178 | # part of the path. The tag can be used to show relative paths in the file list. | ||
185 | 179 | # If left blank the directory from which doxygen is run is used as the path to | ||
186 | 180 | # strip. | ||
187 | 181 | # | ||
188 | 182 | # Note that you can specify absolute paths here, but also relative paths, which | ||
189 | 183 | # will be relative from the directory where doxygen is started. | ||
190 | 184 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. | ||
191 | 185 | |||
192 | 186 | STRIP_FROM_PATH = | ||
193 | 187 | |||
194 | 188 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the | ||
195 | 189 | # path mentioned in the documentation of a class, which tells the reader which | ||
196 | 190 | # header file to include in order to use a class. If left blank only the name of | ||
197 | 191 | # the header file containing the class definition is used. Otherwise one should | ||
198 | 192 | # specify the list of include paths that are normally passed to the compiler | ||
199 | 193 | # using the -I flag. | ||
200 | 194 | |||
201 | 195 | STRIP_FROM_INC_PATH = | ||
202 | 196 | |||
203 | 197 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but | ||
204 | 198 | # less readable) file names. This can be useful is your file systems doesn't | ||
205 | 199 | # support long names like on DOS, Mac, or CD-ROM. | ||
206 | 200 | # The default value is: NO. | ||
207 | 201 | |||
208 | 202 | SHORT_NAMES = NO | ||
209 | 203 | |||
210 | 204 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the | ||
211 | 205 | # first line (until the first dot) of a Javadoc-style comment as the brief | ||
212 | 206 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- | ||
213 | 207 | # style comments (thus requiring an explicit @brief command for a brief | ||
214 | 208 | # description.) | ||
215 | 209 | # The default value is: NO. | ||
216 | 210 | |||
217 | 211 | JAVADOC_AUTOBRIEF = NO | ||
218 | 212 | |||
219 | 213 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line | ||
220 | 214 | # such as | ||
221 | 215 | # /*************** | ||
222 | 216 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the | ||
223 | 217 | # Javadoc-style will behave just like regular comments and it will not be | ||
224 | 218 | # interpreted by doxygen. | ||
225 | 219 | # The default value is: NO. | ||
226 | 220 | |||
227 | 221 | JAVADOC_BANNER = NO | ||
228 | 222 | |||
229 | 223 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first | ||
230 | 224 | # line (until the first dot) of a Qt-style comment as the brief description. If | ||
231 | 225 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus | ||
232 | 226 | # requiring an explicit \brief command for a brief description.) | ||
233 | 227 | # The default value is: NO. | ||
234 | 228 | |||
235 | 229 | QT_AUTOBRIEF = NO | ||
236 | 230 | |||
237 | 231 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a | ||
238 | 232 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as | ||
239 | 233 | # a brief description. This used to be the default behavior. The new default is | ||
240 | 234 | # to treat a multi-line C++ comment block as a detailed description. Set this | ||
241 | 235 | # tag to YES if you prefer the old behavior instead. | ||
242 | 236 | # | ||
243 | 237 | # Note that setting this tag to YES also means that rational rose comments are | ||
244 | 238 | # not recognized any more. | ||
245 | 239 | # The default value is: NO. | ||
246 | 240 | |||
247 | 241 | MULTILINE_CPP_IS_BRIEF = NO | ||
248 | 242 | |||
249 | 243 | # By default Python docstrings are displayed as preformatted text and doxygen's | ||
250 | 244 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the | ||
251 | 245 | # doxygen's special commands can be used and the contents of the docstring | ||
252 | 246 | # documentation blocks is shown as doxygen documentation. | ||
253 | 247 | # The default value is: YES. | ||
254 | 248 | |||
255 | 249 | PYTHON_DOCSTRING = YES | ||
256 | 250 | |||
257 | 251 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the | ||
258 | 252 | # documentation from any documented member that it re-implements. | ||
259 | 253 | # The default value is: YES. | ||
260 | 254 | |||
261 | 255 | INHERIT_DOCS = YES | ||
262 | 256 | |||
263 | 257 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new | ||
264 | 258 | # page for each member. If set to NO, the documentation of a member will be part | ||
265 | 259 | # of the file/class/namespace that contains it. | ||
266 | 260 | # The default value is: NO. | ||
267 | 261 | |||
268 | 262 | SEPARATE_MEMBER_PAGES = NO | ||
269 | 263 | |||
270 | 264 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen | ||
271 | 265 | # uses this value to replace tabs by spaces in code fragments. | ||
272 | 266 | # Minimum value: 1, maximum value: 16, default value: 4. | ||
273 | 267 | |||
274 | 268 | TAB_SIZE = 4 | ||
275 | 269 | |||
276 | 270 | # This tag can be used to specify a number of aliases that act as commands in | ||
277 | 271 | # the documentation. An alias has the form: | ||
278 | 272 | # name=value | ||
279 | 273 | # For example adding | ||
280 | 274 | # "sideeffect=@par Side Effects:^^" | ||
281 | 275 | # will allow you to put the command \sideeffect (or @sideeffect) in the | ||
282 | 276 | # documentation, which will result in a user-defined paragraph with heading | ||
283 | 277 | # "Side Effects:". Note that you cannot put \n's in the value part of an alias | ||
284 | 278 | # to insert newlines (in the resulting output). You can put ^^ in the value part | ||
285 | 279 | # of an alias to insert a newline as if a physical newline was in the original | ||
286 | 280 | # file. When you need a literal { or } or , in the value part of an alias you | ||
287 | 281 | # have to escape them by means of a backslash (\), this can lead to conflicts | ||
288 | 282 | # with the commands \{ and \} for these it is advised to use the version @{ and | ||
289 | 283 | # @} or use a double escape (\\{ and \\}) | ||
290 | 284 | |||
291 | 285 | ALIASES = | ||
292 | 286 | |||
293 | 287 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | ||
294 | 288 | # only. Doxygen will then generate output that is more tailored for C. For | ||
295 | 289 | # instance, some of the names that are used will be different. The list of all | ||
296 | 290 | # members will be omitted, etc. | ||
297 | 291 | # The default value is: NO. | ||
298 | 292 | |||
299 | 293 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
300 | 294 | |||
301 | 295 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or | ||
302 | 296 | # Python sources only. Doxygen will then generate output that is more tailored | ||
303 | 297 | # for that language. For instance, namespaces will be presented as packages, | ||
304 | 298 | # qualified scopes will look different, etc. | ||
305 | 299 | # The default value is: NO. | ||
306 | 300 | |||
307 | 301 | OPTIMIZE_OUTPUT_JAVA = NO | ||
308 | 302 | |||
309 | 303 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | ||
310 | 304 | # sources. Doxygen will then generate output that is tailored for Fortran. | ||
311 | 305 | # The default value is: NO. | ||
312 | 306 | |||
313 | 307 | OPTIMIZE_FOR_FORTRAN = NO | ||
314 | 308 | |||
315 | 309 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | ||
316 | 310 | # sources. Doxygen will then generate output that is tailored for VHDL. | ||
317 | 311 | # The default value is: NO. | ||
318 | 312 | |||
319 | 313 | OPTIMIZE_OUTPUT_VHDL = NO | ||
320 | 314 | |||
321 | 315 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice | ||
322 | 316 | # sources only. Doxygen will then generate output that is more tailored for that | ||
323 | 317 | # language. For instance, namespaces will be presented as modules, types will be | ||
324 | 318 | # separated into more groups, etc. | ||
325 | 319 | # The default value is: NO. | ||
326 | 320 | |||
327 | 321 | OPTIMIZE_OUTPUT_SLICE = NO | ||
328 | 322 | |||
329 | 323 | # Doxygen selects the parser to use depending on the extension of the files it | ||
330 | 324 | # parses. With this tag you can assign which parser to use for a given | ||
331 | 325 | # extension. Doxygen has a built-in mapping, but you can override or extend it | ||
332 | 326 | # using this tag. The format is ext=language, where ext is a file extension, and | ||
333 | 327 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, | ||
334 | 328 | # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, | ||
335 | 329 | # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: | ||
336 | 330 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser | ||
337 | 331 | # tries to guess whether the code is fixed or free formatted code, this is the | ||
338 | 332 | # default for Fortran type files). For instance to make doxygen treat .inc files | ||
339 | 333 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), | ||
340 | 334 | # use: inc=Fortran f=C. | ||
341 | 335 | # | ||
342 | 336 | # Note: For files without extension you can use no_extension as a placeholder. | ||
343 | 337 | # | ||
344 | 338 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise | ||
345 | 339 | # the files are not read by doxygen. When specifying no_extension you should add | ||
346 | 340 | # * to the FILE_PATTERNS. | ||
347 | 341 | # | ||
348 | 342 | # Note see also the list of default file extension mappings. | ||
349 | 343 | |||
350 | 344 | EXTENSION_MAPPING = | ||
351 | 345 | |||
352 | 346 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments | ||
353 | 347 | # according to the Markdown format, which allows for more readable | ||
354 | 348 | # documentation. See https://daringfireball.net/projects/markdown/ for details. | ||
355 | 349 | # The output of markdown processing is further processed by doxygen, so you can | ||
356 | 350 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in | ||
357 | 351 | # case of backward compatibilities issues. | ||
358 | 352 | # The default value is: YES. | ||
359 | 353 | |||
360 | 354 | MARKDOWN_SUPPORT = YES | ||
361 | 355 | |||
362 | 356 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up | ||
363 | 357 | # to that level are automatically included in the table of contents, even if | ||
364 | 358 | # they do not have an id attribute. | ||
365 | 359 | # Note: This feature currently applies only to Markdown headings. | ||
366 | 360 | # Minimum value: 0, maximum value: 99, default value: 5. | ||
367 | 361 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. | ||
368 | 362 | |||
369 | 363 | TOC_INCLUDE_HEADINGS = 5 | ||
370 | 364 | |||
371 | 365 | # When enabled doxygen tries to link words that correspond to documented | ||
372 | 366 | # classes, or namespaces to their corresponding documentation. Such a link can | ||
373 | 367 | # be prevented in individual cases by putting a % sign in front of the word or | ||
374 | 368 | # globally by setting AUTOLINK_SUPPORT to NO. | ||
375 | 369 | # The default value is: YES. | ||
376 | 370 | |||
377 | 371 | AUTOLINK_SUPPORT = YES | ||
378 | 372 | |||
379 | 373 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | ||
380 | 374 | # to include (a tag file for) the STL sources as input, then you should set this | ||
381 | 375 | # tag to YES in order to let doxygen match functions declarations and | ||
382 | 376 | # definitions whose arguments contain STL classes (e.g. func(std::string); | ||
383 | 377 | # versus func(std::string) {}). This also make the inheritance and collaboration | ||
384 | 378 | # diagrams that involve STL classes more complete and accurate. | ||
385 | 379 | # The default value is: NO. | ||
386 | 380 | |||
387 | 381 | BUILTIN_STL_SUPPORT = NO | ||
388 | 382 | |||
389 | 383 | # If you use Microsoft's C++/CLI language, you should set this option to YES to | ||
390 | 384 | # enable parsing support. | ||
391 | 385 | # The default value is: NO. | ||
392 | 386 | |||
393 | 387 | CPP_CLI_SUPPORT = NO | ||
394 | 388 | |||
395 | 389 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: | ||
396 | 390 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen | ||
397 | 391 | # will parse them like normal C++ but will assume all classes use public instead | ||
398 | 392 | # of private inheritance when no explicit protection keyword is present. | ||
399 | 393 | # The default value is: NO. | ||
400 | 394 | |||
401 | 395 | SIP_SUPPORT = NO | ||
402 | 396 | |||
403 | 397 | # For Microsoft's IDL there are propget and propput attributes to indicate | ||
404 | 398 | # getter and setter methods for a property. Setting this option to YES will make | ||
405 | 399 | # doxygen to replace the get and set methods by a property in the documentation. | ||
406 | 400 | # This will only work if the methods are indeed getting or setting a simple | ||
407 | 401 | # type. If this is not the case, or you want to show the methods anyway, you | ||
408 | 402 | # should set this option to NO. | ||
409 | 403 | # The default value is: YES. | ||
410 | 404 | |||
411 | 405 | IDL_PROPERTY_SUPPORT = YES | ||
412 | 406 | |||
413 | 407 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | ||
414 | 408 | # tag is set to YES then doxygen will reuse the documentation of the first | ||
415 | 409 | # member in the group (if any) for the other members of the group. By default | ||
416 | 410 | # all members of a group must be documented explicitly. | ||
417 | 411 | # The default value is: NO. | ||
418 | 412 | |||
419 | 413 | DISTRIBUTE_GROUP_DOC = NO | ||
420 | 414 | |||
421 | 415 | # If one adds a struct or class to a group and this option is enabled, then also | ||
422 | 416 | # any nested class or struct is added to the same group. By default this option | ||
423 | 417 | # is disabled and one has to add nested compounds explicitly via \ingroup. | ||
424 | 418 | # The default value is: NO. | ||
425 | 419 | |||
426 | 420 | GROUP_NESTED_COMPOUNDS = NO | ||
427 | 421 | |||
428 | 422 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type | ||
429 | 423 | # (for instance a group of public functions) to be put as a subgroup of that | ||
430 | 424 | # type (e.g. under the Public Functions section). Set it to NO to prevent | ||
431 | 425 | # subgrouping. Alternatively, this can be done per class using the | ||
432 | 426 | # \nosubgrouping command. | ||
433 | 427 | # The default value is: YES. | ||
434 | 428 | |||
435 | 429 | SUBGROUPING = YES | ||
436 | 430 | |||
437 | 431 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions | ||
438 | 432 | # are shown inside the group in which they are included (e.g. using \ingroup) | ||
439 | 433 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX | ||
440 | 434 | # and RTF). | ||
441 | 435 | # | ||
442 | 436 | # Note that this feature does not work in combination with | ||
443 | 437 | # SEPARATE_MEMBER_PAGES. | ||
444 | 438 | # The default value is: NO. | ||
445 | 439 | |||
446 | 440 | INLINE_GROUPED_CLASSES = NO | ||
447 | 441 | |||
448 | 442 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions | ||
449 | 443 | # with only public data fields or simple typedef fields will be shown inline in | ||
450 | 444 | # the documentation of the scope in which they are defined (i.e. file, | ||
451 | 445 | # namespace, or group documentation), provided this scope is documented. If set | ||
452 | 446 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and | ||
453 | 447 | # Man pages) or section (for LaTeX and RTF). | ||
454 | 448 | # The default value is: NO. | ||
455 | 449 | |||
456 | 450 | INLINE_SIMPLE_STRUCTS = NO | ||
457 | 451 | |||
458 | 452 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or | ||
459 | 453 | # enum is documented as struct, union, or enum with the name of the typedef. So | ||
460 | 454 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | ||
461 | 455 | # with name TypeT. When disabled the typedef will appear as a member of a file, | ||
462 | 456 | # namespace, or class. And the struct will be named TypeS. This can typically be | ||
463 | 457 | # useful for C code in case the coding convention dictates that all compound | ||
464 | 458 | # types are typedef'ed and only the typedef is referenced, never the tag name. | ||
465 | 459 | # The default value is: NO. | ||
466 | 460 | |||
467 | 461 | TYPEDEF_HIDES_STRUCT = NO | ||
468 | 462 | |||
469 | 463 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This | ||
470 | 464 | # cache is used to resolve symbols given their name and scope. Since this can be | ||
471 | 465 | # an expensive process and often the same symbol appears multiple times in the | ||
472 | 466 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small | ||
473 | 467 | # doxygen will become slower. If the cache is too large, memory is wasted. The | ||
474 | 468 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range | ||
475 | 469 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 | ||
476 | 470 | # symbols. At the end of a run doxygen will report the cache usage and suggest | ||
477 | 471 | # the optimal cache size from a speed point of view. | ||
478 | 472 | # Minimum value: 0, maximum value: 9, default value: 0. | ||
479 | 473 | |||
480 | 474 | LOOKUP_CACHE_SIZE = 0 | ||
481 | 475 | |||
482 | 476 | # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use | ||
483 | 477 | # during processing. When set to 0 doxygen will based this on the number of | ||
484 | 478 | # cores available in the system. You can set it explicitly to a value larger | ||
485 | 479 | # than 0 to get more control over the balance between CPU load and processing | ||
486 | 480 | # speed. At this moment only the input processing can be done using multiple | ||
487 | 481 | # threads. Since this is still an experimental feature the default is set to 1, | ||
488 | 482 | # which effectively disables parallel processing. Please report any issues you | ||
489 | 483 | # encounter. Generating dot graphs in parallel is controlled by the | ||
490 | 484 | # DOT_NUM_THREADS setting. | ||
491 | 485 | # Minimum value: 0, maximum value: 32, default value: 1. | ||
492 | 486 | |||
493 | 487 | NUM_PROC_THREADS = 1 | ||
494 | 488 | |||
495 | 489 | #--------------------------------------------------------------------------- | ||
496 | 490 | # Build related configuration options | ||
497 | 491 | #--------------------------------------------------------------------------- | ||
498 | 492 | |||
499 | 493 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in | ||
500 | 494 | # documentation are documented, even if no documentation was available. Private | ||
501 | 495 | # class members and static file members will be hidden unless the | ||
502 | 496 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. | ||
503 | 497 | # Note: This will also disable the warnings about undocumented members that are | ||
504 | 498 | # normally produced when WARNINGS is set to YES. | ||
505 | 499 | # The default value is: NO. | ||
506 | 500 | |||
507 | 501 | EXTRACT_ALL = NO | ||
508 | 502 | |||
509 | 503 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will | ||
510 | 504 | # be included in the documentation. | ||
511 | 505 | # The default value is: NO. | ||
512 | 506 | |||
513 | 507 | EXTRACT_PRIVATE = NO | ||
514 | 508 | |||
515 | 509 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual | ||
516 | 510 | # methods of a class will be included in the documentation. | ||
517 | 511 | # The default value is: NO. | ||
518 | 512 | |||
519 | 513 | EXTRACT_PRIV_VIRTUAL = NO | ||
520 | 514 | |||
521 | 515 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal | ||
522 | 516 | # scope will be included in the documentation. | ||
523 | 517 | # The default value is: NO. | ||
524 | 518 | |||
525 | 519 | EXTRACT_PACKAGE = NO | ||
526 | 520 | |||
527 | 521 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be | ||
528 | 522 | # included in the documentation. | ||
529 | 523 | # The default value is: NO. | ||
530 | 524 | |||
531 | 525 | EXTRACT_STATIC = NO | ||
532 | 526 | |||
533 | 527 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined | ||
534 | 528 | # locally in source files will be included in the documentation. If set to NO, | ||
535 | 529 | # only classes defined in header files are included. Does not have any effect | ||
536 | 530 | # for Java sources. | ||
537 | 531 | # The default value is: YES. | ||
538 | 532 | |||
539 | 533 | EXTRACT_LOCAL_CLASSES = YES | ||
540 | 534 | |||
541 | 535 | # This flag is only useful for Objective-C code. If set to YES, local methods, | ||
542 | 536 | # which are defined in the implementation section but not in the interface are | ||
543 | 537 | # included in the documentation. If set to NO, only methods in the interface are | ||
544 | 538 | # included. | ||
545 | 539 | # The default value is: NO. | ||
546 | 540 | |||
547 | 541 | EXTRACT_LOCAL_METHODS = NO | ||
548 | 542 | |||
549 | 543 | # If this flag is set to YES, the members of anonymous namespaces will be | ||
550 | 544 | # extracted and appear in the documentation as a namespace called | ||
551 | 545 | # 'anonymous_namespace{file}', where file will be replaced with the base name of | ||
552 | 546 | # the file that contains the anonymous namespace. By default anonymous namespace | ||
553 | 547 | # are hidden. | ||
554 | 548 | # The default value is: NO. | ||
555 | 549 | |||
556 | 550 | EXTRACT_ANON_NSPACES = NO | ||
557 | 551 | |||
558 | 552 | # If this flag is set to YES, the name of an unnamed parameter in a declaration | ||
559 | 553 | # will be determined by the corresponding definition. By default unnamed | ||
560 | 554 | # parameters remain unnamed in the output. | ||
561 | 555 | # The default value is: YES. | ||
562 | 556 | |||
563 | 557 | RESOLVE_UNNAMED_PARAMS = YES | ||
564 | 558 | |||
565 | 559 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all | ||
566 | 560 | # undocumented members inside documented classes or files. If set to NO these | ||
567 | 561 | # members will be included in the various overviews, but no documentation | ||
568 | 562 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. | ||
569 | 563 | # The default value is: NO. | ||
570 | 564 | |||
571 | 565 | HIDE_UNDOC_MEMBERS = NO | ||
572 | 566 | |||
573 | 567 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all | ||
574 | 568 | # undocumented classes that are normally visible in the class hierarchy. If set | ||
575 | 569 | # to NO, these classes will be included in the various overviews. This option | ||
576 | 570 | # has no effect if EXTRACT_ALL is enabled. | ||
577 | 571 | # The default value is: NO. | ||
578 | 572 | |||
579 | 573 | HIDE_UNDOC_CLASSES = NO | ||
580 | 574 | |||
581 | 575 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend | ||
582 | 576 | # declarations. If set to NO, these declarations will be included in the | ||
583 | 577 | # documentation. | ||
584 | 578 | # The default value is: NO. | ||
585 | 579 | |||
586 | 580 | HIDE_FRIEND_COMPOUNDS = NO | ||
587 | 581 | |||
588 | 582 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any | ||
589 | 583 | # documentation blocks found inside the body of a function. If set to NO, these | ||
590 | 584 | # blocks will be appended to the function's detailed documentation block. | ||
591 | 585 | # The default value is: NO. | ||
592 | 586 | |||
593 | 587 | HIDE_IN_BODY_DOCS = NO | ||
594 | 588 | |||
595 | 589 | # The INTERNAL_DOCS tag determines if documentation that is typed after a | ||
596 | 590 | # \internal command is included. If the tag is set to NO then the documentation | ||
597 | 591 | # will be excluded. Set it to YES to include the internal documentation. | ||
598 | 592 | # The default value is: NO. | ||
599 | 593 | |||
600 | 594 | INTERNAL_DOCS = NO | ||
601 | 595 | |||
602 | 596 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be | ||
603 | 597 | # able to match the capabilities of the underlying filesystem. In case the | ||
604 | 598 | # filesystem is case sensitive (i.e. it supports files in the same directory | ||
605 | 599 | # whose names only differ in casing), the option must be set to YES to properly | ||
606 | 600 | # deal with such files in case they appear in the input. For filesystems that | ||
607 | 601 | # are not case sensitive the option should be set to NO to properly deal with | ||
608 | 602 | # output files written for symbols that only differ in casing, such as for two | ||
609 | 603 | # classes, one named CLASS and the other named Class, and to also support | ||
610 | 604 | # references to files without having to specify the exact matching casing. On | ||
611 | 605 | # Windows (including Cygwin) and MacOS, users should typically set this option | ||
612 | 606 | # to NO, whereas on Linux or other Unix flavors it should typically be set to | ||
613 | 607 | # YES. | ||
614 | 608 | # The default value is: system dependent. | ||
615 | 609 | |||
616 | 610 | CASE_SENSE_NAMES = YES | ||
617 | 611 | |||
618 | 612 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with | ||
619 | 613 | # their full class and namespace scopes in the documentation. If set to YES, the | ||
620 | 614 | # scope will be hidden. | ||
621 | 615 | # The default value is: NO. | ||
622 | 616 | |||
623 | 617 | HIDE_SCOPE_NAMES = NO | ||
624 | 618 | |||
625 | 619 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will | ||
626 | 620 | # append additional text to a page's title, such as Class Reference. If set to | ||
627 | 621 | # YES the compound reference will be hidden. | ||
628 | 622 | # The default value is: NO. | ||
629 | 623 | |||
630 | 624 | HIDE_COMPOUND_REFERENCE= NO | ||
631 | 625 | |||
632 | 626 | # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class | ||
633 | 627 | # will show which file needs to be included to use the class. | ||
634 | 628 | # The default value is: YES. | ||
635 | 629 | |||
636 | 630 | SHOW_HEADERFILE = YES | ||
637 | 631 | |||
638 | 632 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of | ||
639 | 633 | # the files that are included by a file in the documentation of that file. | ||
640 | 634 | # The default value is: YES. | ||
641 | 635 | |||
642 | 636 | SHOW_INCLUDE_FILES = YES | ||
643 | 637 | |||
644 | 638 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each | ||
645 | 639 | # grouped member an include statement to the documentation, telling the reader | ||
646 | 640 | # which file to include in order to use the member. | ||
647 | 641 | # The default value is: NO. | ||
648 | 642 | |||
649 | 643 | SHOW_GROUPED_MEMB_INC = NO | ||
650 | 644 | |||
651 | 645 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include | ||
652 | 646 | # files with double quotes in the documentation rather than with sharp brackets. | ||
653 | 647 | # The default value is: NO. | ||
654 | 648 | |||
655 | 649 | FORCE_LOCAL_INCLUDES = NO | ||
656 | 650 | |||
657 | 651 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the | ||
658 | 652 | # documentation for inline members. | ||
659 | 653 | # The default value is: YES. | ||
660 | 654 | |||
661 | 655 | INLINE_INFO = YES | ||
662 | 656 | |||
663 | 657 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the | ||
664 | 658 | # (detailed) documentation of file and class members alphabetically by member | ||
665 | 659 | # name. If set to NO, the members will appear in declaration order. | ||
666 | 660 | # The default value is: YES. | ||
667 | 661 | |||
668 | 662 | SORT_MEMBER_DOCS = YES | ||
669 | 663 | |||
670 | 664 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief | ||
671 | 665 | # descriptions of file, namespace and class members alphabetically by member | ||
672 | 666 | # name. If set to NO, the members will appear in declaration order. Note that | ||
673 | 667 | # this will also influence the order of the classes in the class list. | ||
674 | 668 | # The default value is: NO. | ||
675 | 669 | |||
676 | 670 | SORT_BRIEF_DOCS = NO | ||
677 | 671 | |||
678 | 672 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the | ||
679 | 673 | # (brief and detailed) documentation of class members so that constructors and | ||
680 | 674 | # destructors are listed first. If set to NO the constructors will appear in the | ||
681 | 675 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. | ||
682 | 676 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief | ||
683 | 677 | # member documentation. | ||
684 | 678 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting | ||
685 | 679 | # detailed member documentation. | ||
686 | 680 | # The default value is: NO. | ||
687 | 681 | |||
688 | 682 | SORT_MEMBERS_CTORS_1ST = NO | ||
689 | 683 | |||
690 | 684 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy | ||
691 | 685 | # of group names into alphabetical order. If set to NO the group names will | ||
692 | 686 | # appear in their defined order. | ||
693 | 687 | # The default value is: NO. | ||
694 | 688 | |||
695 | 689 | SORT_GROUP_NAMES = NO | ||
696 | 690 | |||
697 | 691 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by | ||
698 | 692 | # fully-qualified names, including namespaces. If set to NO, the class list will | ||
699 | 693 | # be sorted only by class name, not including the namespace part. | ||
700 | 694 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | ||
701 | 695 | # Note: This option applies only to the class list, not to the alphabetical | ||
702 | 696 | # list. | ||
703 | 697 | # The default value is: NO. | ||
704 | 698 | |||
705 | 699 | SORT_BY_SCOPE_NAME = NO | ||
706 | 700 | |||
707 | 701 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper | ||
708 | 702 | # type resolution of all parameters of a function it will reject a match between | ||
709 | 703 | # the prototype and the implementation of a member function even if there is | ||
710 | 704 | # only one candidate or it is obvious which candidate to choose by doing a | ||
711 | 705 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still | ||
712 | 706 | # accept a match between prototype and implementation in such cases. | ||
713 | 707 | # The default value is: NO. | ||
714 | 708 | |||
715 | 709 | STRICT_PROTO_MATCHING = NO | ||
716 | 710 | |||
717 | 711 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo | ||
718 | 712 | # list. This list is created by putting \todo commands in the documentation. | ||
719 | 713 | # The default value is: YES. | ||
720 | 714 | |||
721 | 715 | GENERATE_TODOLIST = YES | ||
722 | 716 | |||
723 | 717 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test | ||
724 | 718 | # list. This list is created by putting \test commands in the documentation. | ||
725 | 719 | # The default value is: YES. | ||
726 | 720 | |||
727 | 721 | GENERATE_TESTLIST = YES | ||
728 | 722 | |||
729 | 723 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug | ||
730 | 724 | # list. This list is created by putting \bug commands in the documentation. | ||
731 | 725 | # The default value is: YES. | ||
732 | 726 | |||
733 | 727 | GENERATE_BUGLIST = YES | ||
734 | 728 | |||
735 | 729 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) | ||
736 | 730 | # the deprecated list. This list is created by putting \deprecated commands in | ||
737 | 731 | # the documentation. | ||
738 | 732 | # The default value is: YES. | ||
739 | 733 | |||
740 | 734 | GENERATE_DEPRECATEDLIST= YES | ||
741 | 735 | |||
742 | 736 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation | ||
743 | 737 | # sections, marked by \if <section_label> ... \endif and \cond <section_label> | ||
744 | 738 | # ... \endcond blocks. | ||
745 | 739 | |||
746 | 740 | ENABLED_SECTIONS = | ||
747 | 741 | |||
748 | 742 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the | ||
749 | 743 | # initial value of a variable or macro / define can have for it to appear in the | ||
750 | 744 | # documentation. If the initializer consists of more lines than specified here | ||
751 | 745 | # it will be hidden. Use a value of 0 to hide initializers completely. The | ||
752 | 746 | # appearance of the value of individual variables and macros / defines can be | ||
753 | 747 | # controlled using \showinitializer or \hideinitializer command in the | ||
754 | 748 | # documentation regardless of this setting. | ||
755 | 749 | # Minimum value: 0, maximum value: 10000, default value: 30. | ||
756 | 750 | |||
757 | 751 | MAX_INITIALIZER_LINES = 30 | ||
758 | 752 | |||
759 | 753 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at | ||
760 | 754 | # the bottom of the documentation of classes and structs. If set to YES, the | ||
761 | 755 | # list will mention the files that were used to generate the documentation. | ||
762 | 756 | # The default value is: YES. | ||
763 | 757 | |||
764 | 758 | SHOW_USED_FILES = YES | ||
765 | 759 | |||
766 | 760 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This | ||
767 | 761 | # will remove the Files entry from the Quick Index and from the Folder Tree View | ||
768 | 762 | # (if specified). | ||
769 | 763 | # The default value is: YES. | ||
770 | 764 | |||
771 | 765 | SHOW_FILES = YES | ||
772 | 766 | |||
773 | 767 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces | ||
774 | 768 | # page. This will remove the Namespaces entry from the Quick Index and from the | ||
775 | 769 | # Folder Tree View (if specified). | ||
776 | 770 | # The default value is: YES. | ||
777 | 771 | |||
778 | 772 | SHOW_NAMESPACES = YES | ||
779 | 773 | |||
780 | 774 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that | ||
781 | 775 | # doxygen should invoke to get the current version for each file (typically from | ||
782 | 776 | # the version control system). Doxygen will invoke the program by executing (via | ||
783 | 777 | # popen()) the command command input-file, where command is the value of the | ||
784 | 778 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided | ||
785 | 779 | # by doxygen. Whatever the program writes to standard output is used as the file | ||
786 | 780 | # version. For an example see the documentation. | ||
787 | 781 | |||
788 | 782 | FILE_VERSION_FILTER = | ||
789 | 783 | |||
790 | 784 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | ||
791 | 785 | # by doxygen. The layout file controls the global structure of the generated | ||
792 | 786 | # output files in an output format independent way. To create the layout file | ||
793 | 787 | # that represents doxygen's defaults, run doxygen with the -l option. You can | ||
794 | 788 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml | ||
795 | 789 | # will be used as the name of the layout file. See also section "Changing the | ||
796 | 790 | # layout of pages" for information. | ||
797 | 791 | # | ||
798 | 792 | # Note that if you run doxygen from a directory containing a file called | ||
799 | 793 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE | ||
800 | 794 | # tag is left empty. | ||
801 | 795 | |||
802 | 796 | LAYOUT_FILE = | ||
803 | 797 | |||
804 | 798 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing | ||
805 | 799 | # the reference definitions. This must be a list of .bib files. The .bib | ||
806 | 800 | # extension is automatically appended if omitted. This requires the bibtex tool | ||
807 | 801 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. | ||
808 | 802 | # For LaTeX the style of the bibliography can be controlled using | ||
809 | 803 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the | ||
810 | 804 | # search path. See also \cite for info how to create references. | ||
811 | 805 | |||
812 | 806 | CITE_BIB_FILES = | ||
813 | 807 | |||
814 | 808 | #--------------------------------------------------------------------------- | ||
815 | 809 | # Configuration options related to warning and progress messages | ||
816 | 810 | #--------------------------------------------------------------------------- | ||
817 | 811 | |||
818 | 812 | # The QUIET tag can be used to turn on/off the messages that are generated to | ||
819 | 813 | # standard output by doxygen. If QUIET is set to YES this implies that the | ||
820 | 814 | # messages are off. | ||
821 | 815 | # The default value is: NO. | ||
822 | 816 | |||
823 | 817 | QUIET = NO | ||
824 | 818 | |||
825 | 819 | # The WARNINGS tag can be used to turn on/off the warning messages that are | ||
826 | 820 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES | ||
827 | 821 | # this implies that the warnings are on. | ||
828 | 822 | # | ||
829 | 823 | # Tip: Turn warnings on while writing the documentation. | ||
830 | 824 | # The default value is: YES. | ||
831 | 825 | |||
832 | 826 | WARNINGS = YES | ||
833 | 827 | |||
834 | 828 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate | ||
835 | 829 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag | ||
836 | 830 | # will automatically be disabled. | ||
837 | 831 | # The default value is: YES. | ||
838 | 832 | |||
839 | 833 | WARN_IF_UNDOCUMENTED = YES | ||
840 | 834 | |||
841 | 835 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for | ||
842 | 836 | # potential errors in the documentation, such as documenting some parameters in | ||
843 | 837 | # a documented function twice, or documenting parameters that don't exist or | ||
844 | 838 | # using markup commands wrongly. | ||
845 | 839 | # The default value is: YES. | ||
846 | 840 | |||
847 | 841 | WARN_IF_DOC_ERROR = YES | ||
848 | 842 | |||
849 | 843 | # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete | ||
850 | 844 | # function parameter documentation. If set to NO, doxygen will accept that some | ||
851 | 845 | # parameters have no documentation without warning. | ||
852 | 846 | # The default value is: YES. | ||
853 | 847 | |||
854 | 848 | WARN_IF_INCOMPLETE_DOC = YES | ||
855 | 849 | |||
856 | 850 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | ||
857 | 851 | # are documented, but have no documentation for their parameters or return | ||
858 | 852 | # value. If set to NO, doxygen will only warn about wrong parameter | ||
859 | 853 | # documentation, but not about the absence of documentation. If EXTRACT_ALL is | ||
860 | 854 | # set to YES then this flag will automatically be disabled. See also | ||
861 | 855 | # WARN_IF_INCOMPLETE_DOC | ||
862 | 856 | # The default value is: NO. | ||
863 | 857 | |||
864 | 858 | WARN_NO_PARAMDOC = NO | ||
865 | 859 | |||
866 | 860 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when | ||
867 | 861 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS | ||
868 | 862 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but | ||
869 | 863 | # at the end of the doxygen process doxygen will return with a non-zero status. | ||
870 | 864 | # Possible values are: NO, YES and FAIL_ON_WARNINGS. | ||
871 | 865 | # The default value is: NO. | ||
872 | 866 | |||
873 | 867 | WARN_AS_ERROR = NO | ||
874 | 868 | |||
875 | 869 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen | ||
876 | 870 | # can produce. The string should contain the $file, $line, and $text tags, which | ||
877 | 871 | # will be replaced by the file and line number from which the warning originated | ||
878 | 872 | # and the warning text. Optionally the format may contain $version, which will | ||
879 | 873 | # be replaced by the version of the file (if it could be obtained via | ||
880 | 874 | # FILE_VERSION_FILTER) | ||
881 | 875 | # See also: WARN_LINE_FORMAT | ||
882 | 876 | # The default value is: $file:$line: $text. | ||
883 | 877 | |||
884 | 878 | WARN_FORMAT = "$file:$line: $text" | ||
885 | 879 | |||
886 | 880 | # In the $text part of the WARN_FORMAT command it is possible that a reference | ||
887 | 881 | # to a more specific place is given. To make it easier to jump to this place | ||
888 | 882 | # (outside of doxygen) the user can define a custom "cut" / "paste" string. | ||
889 | 883 | # Example: | ||
890 | 884 | # WARN_LINE_FORMAT = "'vi $file +$line'" | ||
891 | 885 | # See also: WARN_FORMAT | ||
892 | 886 | # The default value is: at line $line of file $file. | ||
893 | 887 | |||
894 | 888 | WARN_LINE_FORMAT = "at line $line of file $file" | ||
895 | 889 | |||
896 | 890 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error | ||
897 | 891 | # messages should be written. If left blank the output is written to standard | ||
898 | 892 | # error (stderr). In case the file specified cannot be opened for writing the | ||
899 | 893 | # warning and error messages are written to standard error. When as file - is | ||
900 | 894 | # specified the warning and error messages are written to standard output | ||
901 | 895 | # (stdout). | ||
902 | 896 | |||
903 | 897 | WARN_LOGFILE = | ||
904 | 898 | |||
905 | 899 | #--------------------------------------------------------------------------- | ||
906 | 900 | # Configuration options related to the input files | ||
907 | 901 | #--------------------------------------------------------------------------- | ||
908 | 902 | |||
909 | 903 | # The INPUT tag is used to specify the files and/or directories that contain | ||
910 | 904 | # documented source files. You may enter file names like myfile.cpp or | ||
911 | 905 | # directories like /usr/src/myproject. Separate the files or directories with | ||
912 | 906 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING | ||
913 | 907 | # Note: If this tag is empty the current directory is searched. | ||
914 | 908 | |||
915 | 909 | INPUT = src/ include/ | ||
916 | 910 | |||
917 | 911 | # This tag can be used to specify the character encoding of the source files | ||
918 | 912 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | ||
919 | 913 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv | ||
920 | 914 | # documentation (see: | ||
921 | 915 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. | ||
922 | 916 | # The default value is: UTF-8. | ||
923 | 917 | |||
924 | 918 | INPUT_ENCODING = UTF-8 | ||
925 | 919 | |||
926 | 920 | # If the value of the INPUT tag contains directories, you can use the | ||
927 | 921 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | ||
928 | 922 | # *.h) to filter out the source-files in the directories. | ||
929 | 923 | # | ||
930 | 924 | # Note that for custom extensions or not directly supported extensions you also | ||
931 | 925 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
932 | 926 | # read by doxygen. | ||
933 | 927 | # | ||
934 | 928 | # Note the list of default checked file patterns might differ from the list of | ||
935 | 929 | # default file extension mappings. | ||
936 | 930 | # | ||
937 | 931 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | ||
938 | 932 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | ||
939 | 933 | # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, | ||
940 | 934 | # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C | ||
941 | 935 | # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, | ||
942 | 936 | # *.vhdl, *.ucf, *.qsf and *.ice. | ||
943 | 937 | |||
944 | 938 | #FILE_PATTERNS = *.c *.h | ||
945 | 939 | |||
946 | 940 | # The RECURSIVE tag can be used to specify whether or not subdirectories should | ||
947 | 941 | # be searched for input files as well. | ||
948 | 942 | # The default value is: NO. | ||
949 | 943 | |||
950 | 944 | RECURSIVE = YES | ||
951 | 945 | |||
952 | 946 | # The EXCLUDE tag can be used to specify files and/or directories that should be | ||
953 | 947 | # excluded from the INPUT source files. This way you can easily exclude a | ||
954 | 948 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | ||
955 | 949 | # | ||
956 | 950 | # Note that relative paths are relative to the directory from which doxygen is | ||
957 | 951 | # run. | ||
958 | 952 | |||
959 | 953 | EXCLUDE = | ||
960 | 954 | |||
961 | 955 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or | ||
962 | 956 | # directories that are symbolic links (a Unix file system feature) are excluded | ||
963 | 957 | # from the input. | ||
964 | 958 | # The default value is: NO. | ||
965 | 959 | |||
966 | 960 | EXCLUDE_SYMLINKS = NO | ||
967 | 961 | |||
968 | 962 | # If the value of the INPUT tag contains directories, you can use the | ||
969 | 963 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | ||
970 | 964 | # certain files from those directories. | ||
971 | 965 | # | ||
972 | 966 | # Note that the wildcards are matched against the file with absolute path, so to | ||
973 | 967 | # exclude all test directories for example use the pattern */test/* | ||
974 | 968 | |||
975 | 969 | EXCLUDE_PATTERNS = */tests/* */doc/* | ||
976 | 970 | |||
977 | 971 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | ||
978 | 972 | # (namespaces, classes, functions, etc.) that should be excluded from the | ||
979 | 973 | # output. The symbol name can be a fully qualified name, a word, or if the | ||
980 | 974 | # wildcard * is used, a substring. Examples: ANamespace, AClass, | ||
981 | 975 | # ANamespace::AClass, ANamespace::*Test | ||
982 | 976 | # | ||
983 | 977 | # Note that the wildcards are matched against the file with absolute path, so to | ||
984 | 978 | # exclude all test directories use the pattern */test/* | ||
985 | 979 | |||
986 | 980 | EXCLUDE_SYMBOLS = | ||
987 | 981 | |||
988 | 982 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories | ||
989 | 983 | # that contain example code fragments that are included (see the \include | ||
990 | 984 | # command). | ||
991 | 985 | |||
992 | 986 | EXAMPLE_PATH = | ||
993 | 987 | |||
994 | 988 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the | ||
995 | 989 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and | ||
996 | 990 | # *.h) to filter out the source-files in the directories. If left blank all | ||
997 | 991 | # files are included. | ||
998 | 992 | |||
999 | 993 | EXAMPLE_PATTERNS = * | ||
1000 | 994 | |||
1001 | 995 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | ||
1002 | 996 | # searched for input files to be used with the \include or \dontinclude commands | ||
1003 | 997 | # irrespective of the value of the RECURSIVE tag. | ||
1004 | 998 | # The default value is: NO. | ||
1005 | 999 | |||
1006 | 1000 | EXAMPLE_RECURSIVE = NO | ||
1007 | 1001 | |||
1008 | 1002 | # The IMAGE_PATH tag can be used to specify one or more files or directories | ||
1009 | 1003 | # that contain images that are to be included in the documentation (see the | ||
1010 | 1004 | # \image command). | ||
1011 | 1005 | |||
1012 | 1006 | IMAGE_PATH = | ||
1013 | 1007 | |||
1014 | 1008 | # The INPUT_FILTER tag can be used to specify a program that doxygen should | ||
1015 | 1009 | # invoke to filter for each input file. Doxygen will invoke the filter program | ||
1016 | 1010 | # by executing (via popen()) the command: | ||
1017 | 1011 | # | ||
1018 | 1012 | # <filter> <input-file> | ||
1019 | 1013 | # | ||
1020 | 1014 | # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the | ||
1021 | 1015 | # name of an input file. Doxygen will then use the output that the filter | ||
1022 | 1016 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag | ||
1023 | 1017 | # will be ignored. | ||
1024 | 1018 | # | ||
1025 | 1019 | # Note that the filter must not add or remove lines; it is applied before the | ||
1026 | 1020 | # code is scanned, but not when the output code is generated. If lines are added | ||
1027 | 1021 | # or removed, the anchors will not be placed correctly. | ||
1028 | 1022 | # | ||
1029 | 1023 | # Note that for custom extensions or not directly supported extensions you also | ||
1030 | 1024 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
1031 | 1025 | # properly processed by doxygen. | ||
1032 | 1026 | |||
1033 | 1027 | INPUT_FILTER = | ||
1034 | 1028 | |||
1035 | 1029 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | ||
1036 | 1030 | # basis. Doxygen will compare the file name with each pattern and apply the | ||
1037 | 1031 | # filter if there is a match. The filters are a list of the form: pattern=filter | ||
1038 | 1032 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how | ||
1039 | 1033 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the | ||
1040 | 1034 | # patterns match the file name, INPUT_FILTER is applied. | ||
1041 | 1035 | # | ||
1042 | 1036 | # Note that for custom extensions or not directly supported extensions you also | ||
1043 | 1037 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||
1044 | 1038 | # properly processed by doxygen. | ||
1045 | 1039 | |||
1046 | 1040 | FILTER_PATTERNS = | ||
1047 | 1041 | |||
1048 | 1042 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | ||
1049 | 1043 | # INPUT_FILTER) will also be used to filter the input files that are used for | ||
1050 | 1044 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). | ||
1051 | 1045 | # The default value is: NO. | ||
1052 | 1046 | |||
1053 | 1047 | FILTER_SOURCE_FILES = NO | ||
1054 | 1048 | |||
1055 | 1049 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | ||
1056 | 1050 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and | ||
1057 | 1051 | # it is also possible to disable source filtering for a specific pattern using | ||
1058 | 1052 | # *.ext= (so without naming a filter). | ||
1059 | 1053 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. | ||
1060 | 1054 | |||
1061 | 1055 | FILTER_SOURCE_PATTERNS = | ||
1062 | 1056 | |||
1063 | 1057 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that | ||
1064 | 1058 | # is part of the input, its contents will be placed on the main page | ||
1065 | 1059 | # (index.html). This can be useful if you have a project on for instance GitHub | ||
1066 | 1060 | # and want to reuse the introduction page also for the doxygen output. | ||
1067 | 1061 | |||
1068 | 1062 | USE_MDFILE_AS_MAINPAGE = | ||
1069 | 1063 | |||
1070 | 1064 | #--------------------------------------------------------------------------- | ||
1071 | 1065 | # Configuration options related to source browsing | ||
1072 | 1066 | #--------------------------------------------------------------------------- | ||
1073 | 1067 | |||
1074 | 1068 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be | ||
1075 | 1069 | # generated. Documented entities will be cross-referenced with these sources. | ||
1076 | 1070 | # | ||
1077 | 1071 | # Note: To get rid of all source code in the generated output, make sure that | ||
1078 | 1072 | # also VERBATIM_HEADERS is set to NO. | ||
1079 | 1073 | # The default value is: NO. | ||
1080 | 1074 | |||
1081 | 1075 | SOURCE_BROWSER = NO | ||
1082 | 1076 | |||
1083 | 1077 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, | ||
1084 | 1078 | # classes and enums directly into the documentation. | ||
1085 | 1079 | # The default value is: NO. | ||
1086 | 1080 | |||
1087 | 1081 | INLINE_SOURCES = NO | ||
1088 | 1082 | |||
1089 | 1083 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any | ||
1090 | 1084 | # special comment blocks from generated source code fragments. Normal C, C++ and | ||
1091 | 1085 | # Fortran comments will always remain visible. | ||
1092 | 1086 | # The default value is: YES. | ||
1093 | 1087 | |||
1094 | 1088 | STRIP_CODE_COMMENTS = YES | ||
1095 | 1089 | |||
1096 | 1090 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented | ||
1097 | 1091 | # entity all documented functions referencing it will be listed. | ||
1098 | 1092 | # The default value is: NO. | ||
1099 | 1093 | |||
1100 | 1094 | REFERENCED_BY_RELATION = NO | ||
1101 | 1095 | |||
1102 | 1096 | # If the REFERENCES_RELATION tag is set to YES then for each documented function | ||
1103 | 1097 | # all documented entities called/used by that function will be listed. | ||
1104 | 1098 | # The default value is: NO. | ||
1105 | 1099 | |||
1106 | 1100 | REFERENCES_RELATION = NO | ||
1107 | 1101 | |||
1108 | 1102 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set | ||
1109 | 1103 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and | ||
1110 | 1104 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will | ||
1111 | 1105 | # link to the documentation. | ||
1112 | 1106 | # The default value is: YES. | ||
1113 | 1107 | |||
1114 | 1108 | REFERENCES_LINK_SOURCE = YES | ||
1115 | 1109 | |||
1116 | 1110 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the | ||
1117 | 1111 | # source code will show a tooltip with additional information such as prototype, | ||
1118 | 1112 | # brief description and links to the definition and documentation. Since this | ||
1119 | 1113 | # will make the HTML file larger and loading of large files a bit slower, you | ||
1120 | 1114 | # can opt to disable this feature. | ||
1121 | 1115 | # The default value is: YES. | ||
1122 | 1116 | # This tag requires that the tag SOURCE_BROWSER is set to YES. | ||
1123 | 1117 | |||
1124 | 1118 | SOURCE_TOOLTIPS = YES | ||
1125 | 1119 | |||
1126 | 1120 | # If the USE_HTAGS tag is set to YES then the references to source code will | ||
1127 | 1121 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in | ||
1128 | 1122 | # source browser. The htags tool is part of GNU's global source tagging system | ||
1129 | 1123 | # (see https://www.gnu.org/software/global/global.html). You will need version | ||
1130 | 1124 | # 4.8.6 or higher. | ||
1131 | 1125 | # | ||
1132 | 1126 | # To use it do the following: | ||
1133 | 1127 | # - Install the latest version of global | ||
1134 | 1128 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file | ||
1135 | 1129 | # - Make sure the INPUT points to the root of the source tree | ||
1136 | 1130 | # - Run doxygen as normal | ||
1137 | 1131 | # | ||
1138 | 1132 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these | ||
1139 | 1133 | # tools must be available from the command line (i.e. in the search path). | ||
1140 | 1134 | # | ||
1141 | 1135 | # The result: instead of the source browser generated by doxygen, the links to | ||
1142 | 1136 | # source code will now point to the output of htags. | ||
1143 | 1137 | # The default value is: NO. | ||
1144 | 1138 | # This tag requires that the tag SOURCE_BROWSER is set to YES. | ||
1145 | 1139 | |||
1146 | 1140 | USE_HTAGS = NO | ||
1147 | 1141 | |||
1148 | 1142 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a | ||
1149 | 1143 | # verbatim copy of the header file for each class for which an include is | ||
1150 | 1144 | # specified. Set to NO to disable this. | ||
1151 | 1145 | # See also: Section \class. | ||
1152 | 1146 | # The default value is: YES. | ||
1153 | 1147 | |||
1154 | 1148 | VERBATIM_HEADERS = YES | ||
1155 | 1149 | |||
1156 | 1150 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the | ||
1157 | 1151 | # clang parser (see: | ||
1158 | 1152 | # http://clang.llvm.org/) for more accurate parsing at the cost of reduced | ||
1159 | 1153 | # performance. This can be particularly helpful with template rich C++ code for | ||
1160 | 1154 | # which doxygen's built-in parser lacks the necessary type information. | ||
1161 | 1155 | # Note: The availability of this option depends on whether or not doxygen was | ||
1162 | 1156 | # generated with the -Duse_libclang=ON option for CMake. | ||
1163 | 1157 | # The default value is: NO. | ||
1164 | 1158 | |||
1165 | 1159 | CLANG_ASSISTED_PARSING = NO | ||
1166 | 1160 | |||
1167 | 1161 | # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS | ||
1168 | 1162 | # tag is set to YES then doxygen will add the directory of each input to the | ||
1169 | 1163 | # include path. | ||
1170 | 1164 | # The default value is: YES. | ||
1171 | 1165 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||
1172 | 1166 | |||
1173 | 1167 | CLANG_ADD_INC_PATHS = YES | ||
1174 | 1168 | |||
1175 | 1169 | # If clang assisted parsing is enabled you can provide the compiler with command | ||
1176 | 1170 | # line options that you would normally use when invoking the compiler. Note that | ||
1177 | 1171 | # the include paths will already be set by doxygen for the files and directories | ||
1178 | 1172 | # specified with INPUT and INCLUDE_PATH. | ||
1179 | 1173 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||
1180 | 1174 | |||
1181 | 1175 | CLANG_OPTIONS = | ||
1182 | 1176 | |||
1183 | 1177 | # If clang assisted parsing is enabled you can provide the clang parser with the | ||
1184 | 1178 | # path to the directory containing a file called compile_commands.json. This | ||
1185 | 1179 | # file is the compilation database (see: | ||
1186 | 1180 | # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the | ||
1187 | 1181 | # options used when the source files were built. This is equivalent to | ||
1188 | 1182 | # specifying the -p option to a clang tool, such as clang-check. These options | ||
1189 | 1183 | # will then be passed to the parser. Any options specified with CLANG_OPTIONS | ||
1190 | 1184 | # will be added as well. | ||
1191 | 1185 | # Note: The availability of this option depends on whether or not doxygen was | ||
1192 | 1186 | # generated with the -Duse_libclang=ON option for CMake. | ||
1193 | 1187 | |||
1194 | 1188 | CLANG_DATABASE_PATH = | ||
1195 | 1189 | |||
1196 | 1190 | #--------------------------------------------------------------------------- | ||
1197 | 1191 | # Configuration options related to the alphabetical class index | ||
1198 | 1192 | #--------------------------------------------------------------------------- | ||
1199 | 1193 | |||
1200 | 1194 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all | ||
1201 | 1195 | # compounds will be generated. Enable this if the project contains a lot of | ||
1202 | 1196 | # classes, structs, unions or interfaces. | ||
1203 | 1197 | # The default value is: YES. | ||
1204 | 1198 | |||
1205 | 1199 | ALPHABETICAL_INDEX = YES | ||
1206 | 1200 | |||
1207 | 1201 | # In case all classes in a project start with a common prefix, all classes will | ||
1208 | 1202 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag | ||
1209 | 1203 | # can be used to specify a prefix (or a list of prefixes) that should be ignored | ||
1210 | 1204 | # while generating the index headers. | ||
1211 | 1205 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | ||
1212 | 1206 | |||
1213 | 1207 | IGNORE_PREFIX = | ||
1214 | 1208 | |||
1215 | 1209 | #--------------------------------------------------------------------------- | ||
1216 | 1210 | # Configuration options related to the HTML output | ||
1217 | 1211 | #--------------------------------------------------------------------------- | ||
1218 | 1212 | |||
1219 | 1213 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output | ||
1220 | 1214 | # The default value is: YES. | ||
1221 | 1215 | |||
1222 | 1216 | GENERATE_HTML = YES | ||
1223 | 1217 | |||
1224 | 1218 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a | ||
1225 | 1219 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
1226 | 1220 | # it. | ||
1227 | 1221 | # The default directory is: html. | ||
1228 | 1222 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1229 | 1223 | |||
1230 | 1224 | HTML_OUTPUT = html | ||
1231 | 1225 | |||
1232 | 1226 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each | ||
1233 | 1227 | # generated HTML page (for example: .htm, .php, .asp). | ||
1234 | 1228 | # The default value is: .html. | ||
1235 | 1229 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1236 | 1230 | |||
1237 | 1231 | HTML_FILE_EXTENSION = .html | ||
1238 | 1232 | |||
1239 | 1233 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for | ||
1240 | 1234 | # each generated HTML page. If the tag is left blank doxygen will generate a | ||
1241 | 1235 | # standard header. | ||
1242 | 1236 | # | ||
1243 | 1237 | # To get valid HTML the header file that includes any scripts and style sheets | ||
1244 | 1238 | # that doxygen needs, which is dependent on the configuration options used (e.g. | ||
1245 | 1239 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a | ||
1246 | 1240 | # default header using | ||
1247 | 1241 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css | ||
1248 | 1242 | # YourConfigFile | ||
1249 | 1243 | # and then modify the file new_header.html. See also section "Doxygen usage" | ||
1250 | 1244 | # for information on how to generate the default header that doxygen normally | ||
1251 | 1245 | # uses. | ||
1252 | 1246 | # Note: The header is subject to change so you typically have to regenerate the | ||
1253 | 1247 | # default header when upgrading to a newer version of doxygen. For a description | ||
1254 | 1248 | # of the possible markers and block names see the documentation. | ||
1255 | 1249 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1256 | 1250 | |||
1257 | 1251 | HTML_HEADER = | ||
1258 | 1252 | |||
1259 | 1253 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each | ||
1260 | 1254 | # generated HTML page. If the tag is left blank doxygen will generate a standard | ||
1261 | 1255 | # footer. See HTML_HEADER for more information on how to generate a default | ||
1262 | 1256 | # footer and what special commands can be used inside the footer. See also | ||
1263 | 1257 | # section "Doxygen usage" for information on how to generate the default footer | ||
1264 | 1258 | # that doxygen normally uses. | ||
1265 | 1259 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1266 | 1260 | |||
1267 | 1261 | HTML_FOOTER = | ||
1268 | 1262 | |||
1269 | 1263 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style | ||
1270 | 1264 | # sheet that is used by each HTML page. It can be used to fine-tune the look of | ||
1271 | 1265 | # the HTML output. If left blank doxygen will generate a default style sheet. | ||
1272 | 1266 | # See also section "Doxygen usage" for information on how to generate the style | ||
1273 | 1267 | # sheet that doxygen normally uses. | ||
1274 | 1268 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as | ||
1275 | 1269 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become | ||
1276 | 1270 | # obsolete. | ||
1277 | 1271 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1278 | 1272 | |||
1279 | 1273 | HTML_STYLESHEET = | ||
1280 | 1274 | |||
1281 | 1275 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined | ||
1282 | 1276 | # cascading style sheets that are included after the standard style sheets | ||
1283 | 1277 | # created by doxygen. Using this option one can overrule certain style aspects. | ||
1284 | 1278 | # This is preferred over using HTML_STYLESHEET since it does not replace the | ||
1285 | 1279 | # standard style sheet and is therefore more robust against future updates. | ||
1286 | 1280 | # Doxygen will copy the style sheet files to the output directory. | ||
1287 | 1281 | # Note: The order of the extra style sheet files is of importance (e.g. the last | ||
1288 | 1282 | # style sheet in the list overrules the setting of the previous ones in the | ||
1289 | 1283 | # list). For an example see the documentation. | ||
1290 | 1284 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1291 | 1285 | |||
1292 | 1286 | HTML_EXTRA_STYLESHEET = | ||
1293 | 1287 | |||
1294 | 1288 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | ||
1295 | 1289 | # other source files which should be copied to the HTML output directory. Note | ||
1296 | 1290 | # that these files will be copied to the base HTML output directory. Use the | ||
1297 | 1291 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | ||
1298 | 1292 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the | ||
1299 | 1293 | # files will be copied as-is; there are no commands or markers available. | ||
1300 | 1294 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1301 | 1295 | |||
1302 | 1296 | HTML_EXTRA_FILES = | ||
1303 | 1297 | |||
1304 | 1298 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen | ||
1305 | 1299 | # will adjust the colors in the style sheet and background images according to | ||
1306 | 1300 | # this color. Hue is specified as an angle on a color-wheel, see | ||
1307 | 1301 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value | ||
1308 | 1302 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | ||
1309 | 1303 | # purple, and 360 is red again. | ||
1310 | 1304 | # Minimum value: 0, maximum value: 359, default value: 220. | ||
1311 | 1305 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1312 | 1306 | |||
1313 | 1307 | HTML_COLORSTYLE_HUE = 220 | ||
1314 | 1308 | |||
1315 | 1309 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors | ||
1316 | 1310 | # in the HTML output. For a value of 0 the output will use gray-scales only. A | ||
1317 | 1311 | # value of 255 will produce the most vivid colors. | ||
1318 | 1312 | # Minimum value: 0, maximum value: 255, default value: 100. | ||
1319 | 1313 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1320 | 1314 | |||
1321 | 1315 | HTML_COLORSTYLE_SAT = 100 | ||
1322 | 1316 | |||
1323 | 1317 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the | ||
1324 | 1318 | # luminance component of the colors in the HTML output. Values below 100 | ||
1325 | 1319 | # gradually make the output lighter, whereas values above 100 make the output | ||
1326 | 1320 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents | ||
1327 | 1321 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not | ||
1328 | 1322 | # change the gamma. | ||
1329 | 1323 | # Minimum value: 40, maximum value: 240, default value: 80. | ||
1330 | 1324 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1331 | 1325 | |||
1332 | 1326 | HTML_COLORSTYLE_GAMMA = 80 | ||
1333 | 1327 | |||
1334 | 1328 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | ||
1335 | 1329 | # page will contain the date and time when the page was generated. Setting this | ||
1336 | 1330 | # to YES can help to show when doxygen was last run and thus if the | ||
1337 | 1331 | # documentation is up to date. | ||
1338 | 1332 | # The default value is: NO. | ||
1339 | 1333 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1340 | 1334 | |||
1341 | 1335 | HTML_TIMESTAMP = NO | ||
1342 | 1336 | |||
1343 | 1337 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML | ||
1344 | 1338 | # documentation will contain a main index with vertical navigation menus that | ||
1345 | 1339 | # are dynamically created via JavaScript. If disabled, the navigation index will | ||
1346 | 1340 | # consists of multiple levels of tabs that are statically embedded in every HTML | ||
1347 | 1341 | # page. Disable this option to support browsers that do not have JavaScript, | ||
1348 | 1342 | # like the Qt help browser. | ||
1349 | 1343 | # The default value is: YES. | ||
1350 | 1344 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1351 | 1345 | |||
1352 | 1346 | HTML_DYNAMIC_MENUS = YES | ||
1353 | 1347 | |||
1354 | 1348 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | ||
1355 | 1349 | # documentation will contain sections that can be hidden and shown after the | ||
1356 | 1350 | # page has loaded. | ||
1357 | 1351 | # The default value is: NO. | ||
1358 | 1352 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1359 | 1353 | |||
1360 | 1354 | HTML_DYNAMIC_SECTIONS = NO | ||
1361 | 1355 | |||
1362 | 1356 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries | ||
1363 | 1357 | # shown in the various tree structured indices initially; the user can expand | ||
1364 | 1358 | # and collapse entries dynamically later on. Doxygen will expand the tree to | ||
1365 | 1359 | # such a level that at most the specified number of entries are visible (unless | ||
1366 | 1360 | # a fully collapsed tree already exceeds this amount). So setting the number of | ||
1367 | 1361 | # entries 1 will produce a full collapsed tree by default. 0 is a special value | ||
1368 | 1362 | # representing an infinite number of entries and will result in a full expanded | ||
1369 | 1363 | # tree by default. | ||
1370 | 1364 | # Minimum value: 0, maximum value: 9999, default value: 100. | ||
1371 | 1365 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1372 | 1366 | |||
1373 | 1367 | HTML_INDEX_NUM_ENTRIES = 100 | ||
1374 | 1368 | |||
1375 | 1369 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be | ||
1376 | 1370 | # generated that can be used as input for Apple's Xcode 3 integrated development | ||
1377 | 1371 | # environment (see: | ||
1378 | 1372 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To | ||
1379 | 1373 | # create a documentation set, doxygen will generate a Makefile in the HTML | ||
1380 | 1374 | # output directory. Running make will produce the docset in that directory and | ||
1381 | 1375 | # running make install will install the docset in | ||
1382 | 1376 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at | ||
1383 | 1377 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy | ||
1384 | 1378 | # genXcode/_index.html for more information. | ||
1385 | 1379 | # The default value is: NO. | ||
1386 | 1380 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1387 | 1381 | |||
1388 | 1382 | GENERATE_DOCSET = NO | ||
1389 | 1383 | |||
1390 | 1384 | # This tag determines the name of the docset feed. A documentation feed provides | ||
1391 | 1385 | # an umbrella under which multiple documentation sets from a single provider | ||
1392 | 1386 | # (such as a company or product suite) can be grouped. | ||
1393 | 1387 | # The default value is: Doxygen generated docs. | ||
1394 | 1388 | # This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
1395 | 1389 | |||
1396 | 1390 | DOCSET_FEEDNAME = "Doxygen generated docs" | ||
1397 | 1391 | |||
1398 | 1392 | # This tag determines the URL of the docset feed. A documentation feed provides | ||
1399 | 1393 | # an umbrella under which multiple documentation sets from a single provider | ||
1400 | 1394 | # (such as a company or product suite) can be grouped. | ||
1401 | 1395 | # This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
1402 | 1396 | |||
1403 | 1397 | DOCSET_FEEDURL = | ||
1404 | 1398 | |||
1405 | 1399 | # This tag specifies a string that should uniquely identify the documentation | ||
1406 | 1400 | # set bundle. This should be a reverse domain-name style string, e.g. | ||
1407 | 1401 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. | ||
1408 | 1402 | # The default value is: org.doxygen.Project. | ||
1409 | 1403 | # This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
1410 | 1404 | |||
1411 | 1405 | DOCSET_BUNDLE_ID = org.doxygen.Project | ||
1412 | 1406 | |||
1413 | 1407 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify | ||
1414 | 1408 | # the documentation publisher. This should be a reverse domain-name style | ||
1415 | 1409 | # string, e.g. com.mycompany.MyDocSet.documentation. | ||
1416 | 1410 | # The default value is: org.doxygen.Publisher. | ||
1417 | 1411 | # This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
1418 | 1412 | |||
1419 | 1413 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher | ||
1420 | 1414 | |||
1421 | 1415 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. | ||
1422 | 1416 | # The default value is: Publisher. | ||
1423 | 1417 | # This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
1424 | 1418 | |||
1425 | 1419 | DOCSET_PUBLISHER_NAME = Publisher | ||
1426 | 1420 | |||
1427 | 1421 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three | ||
1428 | 1422 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The | ||
1429 | 1423 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | ||
1430 | 1424 | # on Windows. In the beginning of 2021 Microsoft took the original page, with | ||
1431 | 1425 | # a.o. the download links, offline the HTML help workshop was already many years | ||
1432 | 1426 | # in maintenance mode). You can download the HTML help workshop from the web | ||
1433 | 1427 | # archives at Installation executable (see: | ||
1434 | 1428 | # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo | ||
1435 | 1429 | # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). | ||
1436 | 1430 | # | ||
1437 | 1431 | # The HTML Help Workshop contains a compiler that can convert all HTML output | ||
1438 | 1432 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML | ||
1439 | 1433 | # files are now used as the Windows 98 help format, and will replace the old | ||
1440 | 1434 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed | ||
1441 | 1435 | # HTML files also contain an index, a table of contents, and you can search for | ||
1442 | 1436 | # words in the documentation. The HTML workshop also contains a viewer for | ||
1443 | 1437 | # compressed HTML files. | ||
1444 | 1438 | # The default value is: NO. | ||
1445 | 1439 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1446 | 1440 | |||
1447 | 1441 | GENERATE_HTMLHELP = NO | ||
1448 | 1442 | |||
1449 | 1443 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm | ||
1450 | 1444 | # file. You can add a path in front of the file if the result should not be | ||
1451 | 1445 | # written to the html output directory. | ||
1452 | 1446 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
1453 | 1447 | |||
1454 | 1448 | CHM_FILE = | ||
1455 | 1449 | |||
1456 | 1450 | # The HHC_LOCATION tag can be used to specify the location (absolute path | ||
1457 | 1451 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, | ||
1458 | 1452 | # doxygen will try to run the HTML help compiler on the generated index.hhp. | ||
1459 | 1453 | # The file has to be specified with full path. | ||
1460 | 1454 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
1461 | 1455 | |||
1462 | 1456 | HHC_LOCATION = | ||
1463 | 1457 | |||
1464 | 1458 | # The GENERATE_CHI flag controls if a separate .chi index file is generated | ||
1465 | 1459 | # (YES) or that it should be included in the main .chm file (NO). | ||
1466 | 1460 | # The default value is: NO. | ||
1467 | 1461 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
1468 | 1462 | |||
1469 | 1463 | GENERATE_CHI = NO | ||
1470 | 1464 | |||
1471 | 1465 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) | ||
1472 | 1466 | # and project file content. | ||
1473 | 1467 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
1474 | 1468 | |||
1475 | 1469 | CHM_INDEX_ENCODING = | ||
1476 | 1470 | |||
1477 | 1471 | # The BINARY_TOC flag controls whether a binary table of contents is generated | ||
1478 | 1472 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it | ||
1479 | 1473 | # enables the Previous and Next buttons. | ||
1480 | 1474 | # The default value is: NO. | ||
1481 | 1475 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
1482 | 1476 | |||
1483 | 1477 | BINARY_TOC = NO | ||
1484 | 1478 | |||
1485 | 1479 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to | ||
1486 | 1480 | # the table of contents of the HTML help documentation and to the tree view. | ||
1487 | 1481 | # The default value is: NO. | ||
1488 | 1482 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | ||
1489 | 1483 | |||
1490 | 1484 | TOC_EXPAND = NO | ||
1491 | 1485 | |||
1492 | 1486 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | ||
1493 | 1487 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that | ||
1494 | 1488 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help | ||
1495 | 1489 | # (.qch) of the generated HTML documentation. | ||
1496 | 1490 | # The default value is: NO. | ||
1497 | 1491 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1498 | 1492 | |||
1499 | 1493 | GENERATE_QHP = NO | ||
1500 | 1494 | |||
1501 | 1495 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify | ||
1502 | 1496 | # the file name of the resulting .qch file. The path specified is relative to | ||
1503 | 1497 | # the HTML output folder. | ||
1504 | 1498 | # This tag requires that the tag GENERATE_QHP is set to YES. | ||
1505 | 1499 | |||
1506 | 1500 | QCH_FILE = | ||
1507 | 1501 | |||
1508 | 1502 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help | ||
1509 | 1503 | # Project output. For more information please see Qt Help Project / Namespace | ||
1510 | 1504 | # (see: | ||
1511 | 1505 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). | ||
1512 | 1506 | # The default value is: org.doxygen.Project. | ||
1513 | 1507 | # This tag requires that the tag GENERATE_QHP is set to YES. | ||
1514 | 1508 | |||
1515 | 1509 | QHP_NAMESPACE = org.doxygen.Project | ||
1516 | 1510 | |||
1517 | 1511 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt | ||
1518 | 1512 | # Help Project output. For more information please see Qt Help Project / Virtual | ||
1519 | 1513 | # Folders (see: | ||
1520 | 1514 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). | ||
1521 | 1515 | # The default value is: doc. | ||
1522 | 1516 | # This tag requires that the tag GENERATE_QHP is set to YES. | ||
1523 | 1517 | |||
1524 | 1518 | QHP_VIRTUAL_FOLDER = doc | ||
1525 | 1519 | |||
1526 | 1520 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | ||
1527 | 1521 | # filter to add. For more information please see Qt Help Project / Custom | ||
1528 | 1522 | # Filters (see: | ||
1529 | 1523 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). | ||
1530 | 1524 | # This tag requires that the tag GENERATE_QHP is set to YES. | ||
1531 | 1525 | |||
1532 | 1526 | QHP_CUST_FILTER_NAME = | ||
1533 | 1527 | |||
1534 | 1528 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the | ||
1535 | 1529 | # custom filter to add. For more information please see Qt Help Project / Custom | ||
1536 | 1530 | # Filters (see: | ||
1537 | 1531 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). | ||
1538 | 1532 | # This tag requires that the tag GENERATE_QHP is set to YES. | ||
1539 | 1533 | |||
1540 | 1534 | QHP_CUST_FILTER_ATTRS = | ||
1541 | 1535 | |||
1542 | 1536 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | ||
1543 | 1537 | # project's filter section matches. Qt Help Project / Filter Attributes (see: | ||
1544 | 1538 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). | ||
1545 | 1539 | # This tag requires that the tag GENERATE_QHP is set to YES. | ||
1546 | 1540 | |||
1547 | 1541 | QHP_SECT_FILTER_ATTRS = | ||
1548 | 1542 | |||
1549 | 1543 | # The QHG_LOCATION tag can be used to specify the location (absolute path | ||
1550 | 1544 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to | ||
1551 | 1545 | # run qhelpgenerator on the generated .qhp file. | ||
1552 | 1546 | # This tag requires that the tag GENERATE_QHP is set to YES. | ||
1553 | 1547 | |||
1554 | 1548 | QHG_LOCATION = | ||
1555 | 1549 | |||
1556 | 1550 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be | ||
1557 | 1551 | # generated, together with the HTML files, they form an Eclipse help plugin. To | ||
1558 | 1552 | # install this plugin and make it available under the help contents menu in | ||
1559 | 1553 | # Eclipse, the contents of the directory containing the HTML and XML files needs | ||
1560 | 1554 | # to be copied into the plugins directory of eclipse. The name of the directory | ||
1561 | 1555 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. | ||
1562 | 1556 | # After copying Eclipse needs to be restarted before the help appears. | ||
1563 | 1557 | # The default value is: NO. | ||
1564 | 1558 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1565 | 1559 | |||
1566 | 1560 | GENERATE_ECLIPSEHELP = NO | ||
1567 | 1561 | |||
1568 | 1562 | # A unique identifier for the Eclipse help plugin. When installing the plugin | ||
1569 | 1563 | # the directory name containing the HTML and XML files should also have this | ||
1570 | 1564 | # name. Each documentation set should have its own identifier. | ||
1571 | 1565 | # The default value is: org.doxygen.Project. | ||
1572 | 1566 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. | ||
1573 | 1567 | |||
1574 | 1568 | ECLIPSE_DOC_ID = org.doxygen.Project | ||
1575 | 1569 | |||
1576 | 1570 | # If you want full control over the layout of the generated HTML pages it might | ||
1577 | 1571 | # be necessary to disable the index and replace it with your own. The | ||
1578 | 1572 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top | ||
1579 | 1573 | # of each HTML page. A value of NO enables the index and the value YES disables | ||
1580 | 1574 | # it. Since the tabs in the index contain the same information as the navigation | ||
1581 | 1575 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. | ||
1582 | 1576 | # The default value is: NO. | ||
1583 | 1577 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1584 | 1578 | |||
1585 | 1579 | DISABLE_INDEX = NO | ||
1586 | 1580 | |||
1587 | 1581 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | ||
1588 | 1582 | # structure should be generated to display hierarchical information. If the tag | ||
1589 | 1583 | # value is set to YES, a side panel will be generated containing a tree-like | ||
1590 | 1584 | # index structure (just like the one that is generated for HTML Help). For this | ||
1591 | 1585 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required | ||
1592 | 1586 | # (i.e. any modern browser). Windows users are probably better off using the | ||
1593 | 1587 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can | ||
1594 | 1588 | # further fine tune the look of the index (see "Fine-tuning the output"). As an | ||
1595 | 1589 | # example, the default style sheet generated by doxygen has an example that | ||
1596 | 1590 | # shows how to put an image at the root of the tree instead of the PROJECT_NAME. | ||
1597 | 1591 | # Since the tree basically has the same information as the tab index, you could | ||
1598 | 1592 | # consider setting DISABLE_INDEX to YES when enabling this option. | ||
1599 | 1593 | # The default value is: NO. | ||
1600 | 1594 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1601 | 1595 | |||
1602 | 1596 | GENERATE_TREEVIEW = NO | ||
1603 | 1597 | |||
1604 | 1598 | # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the | ||
1605 | 1599 | # FULL_SIDEBAR option determines if the side bar is limited to only the treeview | ||
1606 | 1600 | # area (value NO) or if it should extend to the full height of the window (value | ||
1607 | 1601 | # YES). Setting this to YES gives a layout similar to | ||
1608 | 1602 | # https://docs.readthedocs.io with more room for contents, but less room for the | ||
1609 | 1603 | # project logo, title, and description. If either GENERATE_TREEVIEW or | ||
1610 | 1604 | # DISABLE_INDEX is set to NO, this option has no effect. | ||
1611 | 1605 | # The default value is: NO. | ||
1612 | 1606 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1613 | 1607 | |||
1614 | 1608 | FULL_SIDEBAR = NO | ||
1615 | 1609 | |||
1616 | 1610 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that | ||
1617 | 1611 | # doxygen will group on one line in the generated HTML documentation. | ||
1618 | 1612 | # | ||
1619 | 1613 | # Note that a value of 0 will completely suppress the enum values from appearing | ||
1620 | 1614 | # in the overview section. | ||
1621 | 1615 | # Minimum value: 0, maximum value: 20, default value: 4. | ||
1622 | 1616 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1623 | 1617 | |||
1624 | 1618 | ENUM_VALUES_PER_LINE = 4 | ||
1625 | 1619 | |||
1626 | 1620 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used | ||
1627 | 1621 | # to set the initial width (in pixels) of the frame in which the tree is shown. | ||
1628 | 1622 | # Minimum value: 0, maximum value: 1500, default value: 250. | ||
1629 | 1623 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1630 | 1624 | |||
1631 | 1625 | TREEVIEW_WIDTH = 250 | ||
1632 | 1626 | |||
1633 | 1627 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to | ||
1634 | 1628 | # external symbols imported via tag files in a separate window. | ||
1635 | 1629 | # The default value is: NO. | ||
1636 | 1630 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1637 | 1631 | |||
1638 | 1632 | EXT_LINKS_IN_WINDOW = NO | ||
1639 | 1633 | |||
1640 | 1634 | # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email | ||
1641 | 1635 | # addresses. | ||
1642 | 1636 | # The default value is: YES. | ||
1643 | 1637 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1644 | 1638 | |||
1645 | 1639 | OBFUSCATE_EMAILS = YES | ||
1646 | 1640 | |||
1647 | 1641 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg | ||
1648 | 1642 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see | ||
1649 | 1643 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for | ||
1650 | 1644 | # the HTML output. These images will generally look nicer at scaled resolutions. | ||
1651 | 1645 | # Possible values are: png (the default) and svg (looks nicer but requires the | ||
1652 | 1646 | # pdf2svg or inkscape tool). | ||
1653 | 1647 | # The default value is: png. | ||
1654 | 1648 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1655 | 1649 | |||
1656 | 1650 | HTML_FORMULA_FORMAT = png | ||
1657 | 1651 | |||
1658 | 1652 | # Use this tag to change the font size of LaTeX formulas included as images in | ||
1659 | 1653 | # the HTML documentation. When you change the font size after a successful | ||
1660 | 1654 | # doxygen run you need to manually remove any form_*.png images from the HTML | ||
1661 | 1655 | # output directory to force them to be regenerated. | ||
1662 | 1656 | # Minimum value: 8, maximum value: 50, default value: 10. | ||
1663 | 1657 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1664 | 1658 | |||
1665 | 1659 | FORMULA_FONTSIZE = 10 | ||
1666 | 1660 | |||
1667 | 1661 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images | ||
1668 | 1662 | # generated for formulas are transparent PNGs. Transparent PNGs are not | ||
1669 | 1663 | # supported properly for IE 6.0, but are supported on all modern browsers. | ||
1670 | 1664 | # | ||
1671 | 1665 | # Note that when changing this option you need to delete any form_*.png files in | ||
1672 | 1666 | # the HTML output directory before the changes have effect. | ||
1673 | 1667 | # The default value is: YES. | ||
1674 | 1668 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1675 | 1669 | |||
1676 | 1670 | FORMULA_TRANSPARENT = YES | ||
1677 | 1671 | |||
1678 | 1672 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands | ||
1679 | 1673 | # to create new LaTeX commands to be used in formulas as building blocks. See | ||
1680 | 1674 | # the section "Including formulas" for details. | ||
1681 | 1675 | |||
1682 | 1676 | FORMULA_MACROFILE = | ||
1683 | 1677 | |||
1684 | 1678 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see | ||
1685 | 1679 | # https://www.mathjax.org) which uses client side JavaScript for the rendering | ||
1686 | 1680 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX | ||
1687 | 1681 | # installed or if you want to formulas look prettier in the HTML output. When | ||
1688 | 1682 | # enabled you may also need to install MathJax separately and configure the path | ||
1689 | 1683 | # to it using the MATHJAX_RELPATH option. | ||
1690 | 1684 | # The default value is: NO. | ||
1691 | 1685 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1692 | 1686 | |||
1693 | 1687 | USE_MATHJAX = NO | ||
1694 | 1688 | |||
1695 | 1689 | # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. | ||
1696 | 1690 | # Note that the different versions of MathJax have different requirements with | ||
1697 | 1691 | # regards to the different settings, so it is possible that also other MathJax | ||
1698 | 1692 | # settings have to be changed when switching between the different MathJax | ||
1699 | 1693 | # versions. | ||
1700 | 1694 | # Possible values are: MathJax_2 and MathJax_3. | ||
1701 | 1695 | # The default value is: MathJax_2. | ||
1702 | 1696 | # This tag requires that the tag USE_MATHJAX is set to YES. | ||
1703 | 1697 | |||
1704 | 1698 | MATHJAX_VERSION = MathJax_2 | ||
1705 | 1699 | |||
1706 | 1700 | # When MathJax is enabled you can set the default output format to be used for | ||
1707 | 1701 | # the MathJax output. For more details about the output format see MathJax | ||
1708 | 1702 | # version 2 (see: | ||
1709 | 1703 | # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 | ||
1710 | 1704 | # (see: | ||
1711 | 1705 | # http://docs.mathjax.org/en/latest/web/components/output.html). | ||
1712 | 1706 | # Possible values are: HTML-CSS (which is slower, but has the best | ||
1713 | 1707 | # compatibility. This is the name for Mathjax version 2, for MathJax version 3 | ||
1714 | 1708 | # this will be translated into chtml), NativeMML (i.e. MathML. Only supported | ||
1715 | 1709 | # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This | ||
1716 | 1710 | # is the name for Mathjax version 3, for MathJax version 2 this will be | ||
1717 | 1711 | # translated into HTML-CSS) and SVG. | ||
1718 | 1712 | # The default value is: HTML-CSS. | ||
1719 | 1713 | # This tag requires that the tag USE_MATHJAX is set to YES. | ||
1720 | 1714 | |||
1721 | 1715 | MATHJAX_FORMAT = HTML-CSS | ||
1722 | 1716 | |||
1723 | 1717 | # When MathJax is enabled you need to specify the location relative to the HTML | ||
1724 | 1718 | # output directory using the MATHJAX_RELPATH option. The destination directory | ||
1725 | 1719 | # should contain the MathJax.js script. For instance, if the mathjax directory | ||
1726 | 1720 | # is located at the same level as the HTML output directory, then | ||
1727 | 1721 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | ||
1728 | 1722 | # Content Delivery Network so you can quickly see the result without installing | ||
1729 | 1723 | # MathJax. However, it is strongly recommended to install a local copy of | ||
1730 | 1724 | # MathJax from https://www.mathjax.org before deployment. The default value is: | ||
1731 | 1725 | # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 | ||
1732 | 1726 | # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 | ||
1733 | 1727 | # This tag requires that the tag USE_MATHJAX is set to YES. | ||
1734 | 1728 | |||
1735 | 1729 | MATHJAX_RELPATH = | ||
1736 | 1730 | |||
1737 | 1731 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax | ||
1738 | 1732 | # extension names that should be enabled during MathJax rendering. For example | ||
1739 | 1733 | # for MathJax version 2 (see | ||
1740 | 1734 | # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): | ||
1741 | 1735 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | ||
1742 | 1736 | # For example for MathJax version 3 (see | ||
1743 | 1737 | # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): | ||
1744 | 1738 | # MATHJAX_EXTENSIONS = ams | ||
1745 | 1739 | # This tag requires that the tag USE_MATHJAX is set to YES. | ||
1746 | 1740 | |||
1747 | 1741 | MATHJAX_EXTENSIONS = | ||
1748 | 1742 | |||
1749 | 1743 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces | ||
1750 | 1744 | # of code that will be used on startup of the MathJax code. See the MathJax site | ||
1751 | 1745 | # (see: | ||
1752 | 1746 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an | ||
1753 | 1747 | # example see the documentation. | ||
1754 | 1748 | # This tag requires that the tag USE_MATHJAX is set to YES. | ||
1755 | 1749 | |||
1756 | 1750 | MATHJAX_CODEFILE = | ||
1757 | 1751 | |||
1758 | 1752 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for | ||
1759 | 1753 | # the HTML output. The underlying search engine uses javascript and DHTML and | ||
1760 | 1754 | # should work on any modern browser. Note that when using HTML help | ||
1761 | 1755 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) | ||
1762 | 1756 | # there is already a search function so this one should typically be disabled. | ||
1763 | 1757 | # For large projects the javascript based search engine can be slow, then | ||
1764 | 1758 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to | ||
1765 | 1759 | # search using the keyboard; to jump to the search box use <access key> + S | ||
1766 | 1760 | # (what the <access key> is depends on the OS and browser, but it is typically | ||
1767 | 1761 | # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down | ||
1768 | 1762 | # key> to jump into the search results window, the results can be navigated | ||
1769 | 1763 | # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel | ||
1770 | 1764 | # the search. The filter options can be selected when the cursor is inside the | ||
1771 | 1765 | # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> | ||
1772 | 1766 | # to select a filter and <Enter> or <escape> to activate or cancel the filter | ||
1773 | 1767 | # option. | ||
1774 | 1768 | # The default value is: YES. | ||
1775 | 1769 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1776 | 1770 | |||
1777 | 1771 | SEARCHENGINE = YES | ||
1778 | 1772 | |||
1779 | 1773 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | ||
1780 | 1774 | # implemented using a web server instead of a web client using JavaScript. There | ||
1781 | 1775 | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH | ||
1782 | 1776 | # setting. When disabled, doxygen will generate a PHP script for searching and | ||
1783 | 1777 | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | ||
1784 | 1778 | # and searching needs to be provided by external tools. See the section | ||
1785 | 1779 | # "External Indexing and Searching" for details. | ||
1786 | 1780 | # The default value is: NO. | ||
1787 | 1781 | # This tag requires that the tag SEARCHENGINE is set to YES. | ||
1788 | 1782 | |||
1789 | 1783 | SERVER_BASED_SEARCH = NO | ||
1790 | 1784 | |||
1791 | 1785 | # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP | ||
1792 | 1786 | # script for searching. Instead the search results are written to an XML file | ||
1793 | 1787 | # which needs to be processed by an external indexer. Doxygen will invoke an | ||
1794 | 1788 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain the | ||
1795 | 1789 | # search results. | ||
1796 | 1790 | # | ||
1797 | 1791 | # Doxygen ships with an example indexer (doxyindexer) and search engine | ||
1798 | 1792 | # (doxysearch.cgi) which are based on the open source search engine library | ||
1799 | 1793 | # Xapian (see: | ||
1800 | 1794 | # https://xapian.org/). | ||
1801 | 1795 | # | ||
1802 | 1796 | # See the section "External Indexing and Searching" for details. | ||
1803 | 1797 | # The default value is: NO. | ||
1804 | 1798 | # This tag requires that the tag SEARCHENGINE is set to YES. | ||
1805 | 1799 | |||
1806 | 1800 | EXTERNAL_SEARCH = NO | ||
1807 | 1801 | |||
1808 | 1802 | # The SEARCHENGINE_URL should point to a search engine hosted by a web server | ||
1809 | 1803 | # which will return the search results when EXTERNAL_SEARCH is enabled. | ||
1810 | 1804 | # | ||
1811 | 1805 | # Doxygen ships with an example indexer (doxyindexer) and search engine | ||
1812 | 1806 | # (doxysearch.cgi) which are based on the open source search engine library | ||
1813 | 1807 | # Xapian (see: | ||
1814 | 1808 | # https://xapian.org/). See the section "External Indexing and Searching" for | ||
1815 | 1809 | # details. | ||
1816 | 1810 | # This tag requires that the tag SEARCHENGINE is set to YES. | ||
1817 | 1811 | |||
1818 | 1812 | SEARCHENGINE_URL = | ||
1819 | 1813 | |||
1820 | 1814 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed | ||
1821 | 1815 | # search data is written to a file for indexing by an external tool. With the | ||
1822 | 1816 | # SEARCHDATA_FILE tag the name of this file can be specified. | ||
1823 | 1817 | # The default file is: searchdata.xml. | ||
1824 | 1818 | # This tag requires that the tag SEARCHENGINE is set to YES. | ||
1825 | 1819 | |||
1826 | 1820 | SEARCHDATA_FILE = searchdata.xml | ||
1827 | 1821 | |||
1828 | 1822 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the | ||
1829 | 1823 | # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is | ||
1830 | 1824 | # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple | ||
1831 | 1825 | # projects and redirect the results back to the right project. | ||
1832 | 1826 | # This tag requires that the tag SEARCHENGINE is set to YES. | ||
1833 | 1827 | |||
1834 | 1828 | EXTERNAL_SEARCH_ID = | ||
1835 | 1829 | |||
1836 | 1830 | # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen | ||
1837 | 1831 | # projects other than the one defined by this configuration file, but that are | ||
1838 | 1832 | # all added to the same external search index. Each project needs to have a | ||
1839 | 1833 | # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of | ||
1840 | 1834 | # to a relative location where the documentation can be found. The format is: | ||
1841 | 1835 | # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... | ||
1842 | 1836 | # This tag requires that the tag SEARCHENGINE is set to YES. | ||
1843 | 1837 | |||
1844 | 1838 | EXTRA_SEARCH_MAPPINGS = | ||
1845 | 1839 | |||
1846 | 1840 | #--------------------------------------------------------------------------- | ||
1847 | 1841 | # Configuration options related to the LaTeX output | ||
1848 | 1842 | #--------------------------------------------------------------------------- | ||
1849 | 1843 | |||
1850 | 1844 | # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. | ||
1851 | 1845 | # The default value is: YES. | ||
1852 | 1846 | |||
1853 | 1847 | GENERATE_LATEX = NO | ||
1854 | 1848 | |||
1855 | 1849 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a | ||
1856 | 1850 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
1857 | 1851 | # it. | ||
1858 | 1852 | # The default directory is: latex. | ||
1859 | 1853 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1860 | 1854 | |||
1861 | 1855 | LATEX_OUTPUT = latex | ||
1862 | 1856 | |||
1863 | 1857 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | ||
1864 | 1858 | # invoked. | ||
1865 | 1859 | # | ||
1866 | 1860 | # Note that when not enabling USE_PDFLATEX the default is latex when enabling | ||
1867 | 1861 | # USE_PDFLATEX the default is pdflatex and when in the later case latex is | ||
1868 | 1862 | # chosen this is overwritten by pdflatex. For specific output languages the | ||
1869 | 1863 | # default can have been set differently, this depends on the implementation of | ||
1870 | 1864 | # the output language. | ||
1871 | 1865 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1872 | 1866 | |||
1873 | 1867 | LATEX_CMD_NAME = | ||
1874 | 1868 | |||
1875 | 1869 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate | ||
1876 | 1870 | # index for LaTeX. | ||
1877 | 1871 | # Note: This tag is used in the Makefile / make.bat. | ||
1878 | 1872 | # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file | ||
1879 | 1873 | # (.tex). | ||
1880 | 1874 | # The default file is: makeindex. | ||
1881 | 1875 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1882 | 1876 | |||
1883 | 1877 | MAKEINDEX_CMD_NAME = makeindex | ||
1884 | 1878 | |||
1885 | 1879 | # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to | ||
1886 | 1880 | # generate index for LaTeX. In case there is no backslash (\) as first character | ||
1887 | 1881 | # it will be automatically added in the LaTeX code. | ||
1888 | 1882 | # Note: This tag is used in the generated output file (.tex). | ||
1889 | 1883 | # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. | ||
1890 | 1884 | # The default value is: makeindex. | ||
1891 | 1885 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1892 | 1886 | |||
1893 | 1887 | LATEX_MAKEINDEX_CMD = makeindex | ||
1894 | 1888 | |||
1895 | 1889 | # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX | ||
1896 | 1890 | # documents. This may be useful for small projects and may help to save some | ||
1897 | 1891 | # trees in general. | ||
1898 | 1892 | # The default value is: NO. | ||
1899 | 1893 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1900 | 1894 | |||
1901 | 1895 | COMPACT_LATEX = NO | ||
1902 | 1896 | |||
1903 | 1897 | # The PAPER_TYPE tag can be used to set the paper type that is used by the | ||
1904 | 1898 | # printer. | ||
1905 | 1899 | # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x | ||
1906 | 1900 | # 14 inches) and executive (7.25 x 10.5 inches). | ||
1907 | 1901 | # The default value is: a4. | ||
1908 | 1902 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1909 | 1903 | |||
1910 | 1904 | PAPER_TYPE = a4 | ||
1911 | 1905 | |||
1912 | 1906 | # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names | ||
1913 | 1907 | # that should be included in the LaTeX output. The package can be specified just | ||
1914 | 1908 | # by its name or with the correct syntax as to be used with the LaTeX | ||
1915 | 1909 | # \usepackage command. To get the times font for instance you can specify : | ||
1916 | 1910 | # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} | ||
1917 | 1911 | # To use the option intlimits with the amsmath package you can specify: | ||
1918 | 1912 | # EXTRA_PACKAGES=[intlimits]{amsmath} | ||
1919 | 1913 | # If left blank no extra packages will be included. | ||
1920 | 1914 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1921 | 1915 | |||
1922 | 1916 | EXTRA_PACKAGES = | ||
1923 | 1917 | |||
1924 | 1918 | # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for | ||
1925 | 1919 | # the generated LaTeX document. The header should contain everything until the | ||
1926 | 1920 | # first chapter. If it is left blank doxygen will generate a standard header. It | ||
1927 | 1921 | # is highly recommended to start with a default header using | ||
1928 | 1922 | # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty | ||
1929 | 1923 | # and then modify the file new_header.tex. See also section "Doxygen usage" for | ||
1930 | 1924 | # information on how to generate the default header that doxygen normally uses. | ||
1931 | 1925 | # | ||
1932 | 1926 | # Note: Only use a user-defined header if you know what you are doing! | ||
1933 | 1927 | # Note: The header is subject to change so you typically have to regenerate the | ||
1934 | 1928 | # default header when upgrading to a newer version of doxygen. The following | ||
1935 | 1929 | # commands have a special meaning inside the header (and footer): For a | ||
1936 | 1930 | # description of the possible markers and block names see the documentation. | ||
1937 | 1931 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1938 | 1932 | |||
1939 | 1933 | LATEX_HEADER = | ||
1940 | 1934 | |||
1941 | 1935 | # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for | ||
1942 | 1936 | # the generated LaTeX document. The footer should contain everything after the | ||
1943 | 1937 | # last chapter. If it is left blank doxygen will generate a standard footer. See | ||
1944 | 1938 | # LATEX_HEADER for more information on how to generate a default footer and what | ||
1945 | 1939 | # special commands can be used inside the footer. See also section "Doxygen | ||
1946 | 1940 | # usage" for information on how to generate the default footer that doxygen | ||
1947 | 1941 | # normally uses. Note: Only use a user-defined footer if you know what you are | ||
1948 | 1942 | # doing! | ||
1949 | 1943 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1950 | 1944 | |||
1951 | 1945 | LATEX_FOOTER = | ||
1952 | 1946 | |||
1953 | 1947 | # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined | ||
1954 | 1948 | # LaTeX style sheets that are included after the standard style sheets created | ||
1955 | 1949 | # by doxygen. Using this option one can overrule certain style aspects. Doxygen | ||
1956 | 1950 | # will copy the style sheet files to the output directory. | ||
1957 | 1951 | # Note: The order of the extra style sheet files is of importance (e.g. the last | ||
1958 | 1952 | # style sheet in the list overrules the setting of the previous ones in the | ||
1959 | 1953 | # list). | ||
1960 | 1954 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1961 | 1955 | |||
1962 | 1956 | LATEX_EXTRA_STYLESHEET = | ||
1963 | 1957 | |||
1964 | 1958 | # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or | ||
1965 | 1959 | # other source files which should be copied to the LATEX_OUTPUT output | ||
1966 | 1960 | # directory. Note that the files will be copied as-is; there are no commands or | ||
1967 | 1961 | # markers available. | ||
1968 | 1962 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1969 | 1963 | |||
1970 | 1964 | LATEX_EXTRA_FILES = | ||
1971 | 1965 | |||
1972 | 1966 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is | ||
1973 | 1967 | # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will | ||
1974 | 1968 | # contain links (just like the HTML output) instead of page references. This | ||
1975 | 1969 | # makes the output suitable for online browsing using a PDF viewer. | ||
1976 | 1970 | # The default value is: YES. | ||
1977 | 1971 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1978 | 1972 | |||
1979 | 1973 | PDF_HYPERLINKS = YES | ||
1980 | 1974 | |||
1981 | 1975 | # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as | ||
1982 | 1976 | # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX | ||
1983 | 1977 | # files. Set this option to YES, to get a higher quality PDF documentation. | ||
1984 | 1978 | # | ||
1985 | 1979 | # See also section LATEX_CMD_NAME for selecting the engine. | ||
1986 | 1980 | # The default value is: YES. | ||
1987 | 1981 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1988 | 1982 | |||
1989 | 1983 | USE_PDFLATEX = YES | ||
1990 | 1984 | |||
1991 | 1985 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode | ||
1992 | 1986 | # command to the generated LaTeX files. This will instruct LaTeX to keep running | ||
1993 | 1987 | # if errors occur, instead of asking the user for help. | ||
1994 | 1988 | # The default value is: NO. | ||
1995 | 1989 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1996 | 1990 | |||
1997 | 1991 | LATEX_BATCHMODE = NO | ||
1998 | 1992 | |||
1999 | 1993 | # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the | ||
2000 | 1994 | # index chapters (such as File Index, Compound Index, etc.) in the output. | ||
2001 | 1995 | # The default value is: NO. | ||
2002 | 1996 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
2003 | 1997 | |||
2004 | 1998 | LATEX_HIDE_INDICES = NO | ||
2005 | 1999 | |||
2006 | 2000 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the | ||
2007 | 2001 | # bibliography, e.g. plainnat, or ieeetr. See | ||
2008 | 2002 | # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. | ||
2009 | 2003 | # The default value is: plain. | ||
2010 | 2004 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
2011 | 2005 | |||
2012 | 2006 | LATEX_BIB_STYLE = plain | ||
2013 | 2007 | |||
2014 | 2008 | # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated | ||
2015 | 2009 | # page will contain the date and time when the page was generated. Setting this | ||
2016 | 2010 | # to NO can help when comparing the output of multiple runs. | ||
2017 | 2011 | # The default value is: NO. | ||
2018 | 2012 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
2019 | 2013 | |||
2020 | 2014 | LATEX_TIMESTAMP = NO | ||
2021 | 2015 | |||
2022 | 2016 | # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) | ||
2023 | 2017 | # path from which the emoji images will be read. If a relative path is entered, | ||
2024 | 2018 | # it will be relative to the LATEX_OUTPUT directory. If left blank the | ||
2025 | 2019 | # LATEX_OUTPUT directory will be used. | ||
2026 | 2020 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
2027 | 2021 | |||
2028 | 2022 | LATEX_EMOJI_DIRECTORY = | ||
2029 | 2023 | |||
2030 | 2024 | #--------------------------------------------------------------------------- | ||
2031 | 2025 | # Configuration options related to the RTF output | ||
2032 | 2026 | #--------------------------------------------------------------------------- | ||
2033 | 2027 | |||
2034 | 2028 | # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The | ||
2035 | 2029 | # RTF output is optimized for Word 97 and may not look too pretty with other RTF | ||
2036 | 2030 | # readers/editors. | ||
2037 | 2031 | # The default value is: NO. | ||
2038 | 2032 | |||
2039 | 2033 | GENERATE_RTF = NO | ||
2040 | 2034 | |||
2041 | 2035 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a | ||
2042 | 2036 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
2043 | 2037 | # it. | ||
2044 | 2038 | # The default directory is: rtf. | ||
2045 | 2039 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
2046 | 2040 | |||
2047 | 2041 | RTF_OUTPUT = rtf | ||
2048 | 2042 | |||
2049 | 2043 | # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF | ||
2050 | 2044 | # documents. This may be useful for small projects and may help to save some | ||
2051 | 2045 | # trees in general. | ||
2052 | 2046 | # The default value is: NO. | ||
2053 | 2047 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
2054 | 2048 | |||
2055 | 2049 | COMPACT_RTF = NO | ||
2056 | 2050 | |||
2057 | 2051 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will | ||
2058 | 2052 | # contain hyperlink fields. The RTF file will contain links (just like the HTML | ||
2059 | 2053 | # output) instead of page references. This makes the output suitable for online | ||
2060 | 2054 | # browsing using Word or some other Word compatible readers that support those | ||
2061 | 2055 | # fields. | ||
2062 | 2056 | # | ||
2063 | 2057 | # Note: WordPad (write) and others do not support links. | ||
2064 | 2058 | # The default value is: NO. | ||
2065 | 2059 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
2066 | 2060 | |||
2067 | 2061 | RTF_HYPERLINKS = NO | ||
2068 | 2062 | |||
2069 | 2063 | # Load stylesheet definitions from file. Syntax is similar to doxygen's | ||
2070 | 2064 | # configuration file, i.e. a series of assignments. You only have to provide | ||
2071 | 2065 | # replacements, missing definitions are set to their default value. | ||
2072 | 2066 | # | ||
2073 | 2067 | # See also section "Doxygen usage" for information on how to generate the | ||
2074 | 2068 | # default style sheet that doxygen normally uses. | ||
2075 | 2069 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
2076 | 2070 | |||
2077 | 2071 | RTF_STYLESHEET_FILE = | ||
2078 | 2072 | |||
2079 | 2073 | # Set optional variables used in the generation of an RTF document. Syntax is | ||
2080 | 2074 | # similar to doxygen's configuration file. A template extensions file can be | ||
2081 | 2075 | # generated using doxygen -e rtf extensionFile. | ||
2082 | 2076 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
2083 | 2077 | |||
2084 | 2078 | RTF_EXTENSIONS_FILE = | ||
2085 | 2079 | |||
2086 | 2080 | #--------------------------------------------------------------------------- | ||
2087 | 2081 | # Configuration options related to the man page output | ||
2088 | 2082 | #--------------------------------------------------------------------------- | ||
2089 | 2083 | |||
2090 | 2084 | # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for | ||
2091 | 2085 | # classes and files. | ||
2092 | 2086 | # The default value is: NO. | ||
2093 | 2087 | |||
2094 | 2088 | GENERATE_MAN = NO | ||
2095 | 2089 | |||
2096 | 2090 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a | ||
2097 | 2091 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
2098 | 2092 | # it. A directory man3 will be created inside the directory specified by | ||
2099 | 2093 | # MAN_OUTPUT. | ||
2100 | 2094 | # The default directory is: man. | ||
2101 | 2095 | # This tag requires that the tag GENERATE_MAN is set to YES. | ||
2102 | 2096 | |||
2103 | 2097 | MAN_OUTPUT = man | ||
2104 | 2098 | |||
2105 | 2099 | # The MAN_EXTENSION tag determines the extension that is added to the generated | ||
2106 | 2100 | # man pages. In case the manual section does not start with a number, the number | ||
2107 | 2101 | # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is | ||
2108 | 2102 | # optional. | ||
2109 | 2103 | # The default value is: .3. | ||
2110 | 2104 | # This tag requires that the tag GENERATE_MAN is set to YES. | ||
2111 | 2105 | |||
2112 | 2106 | MAN_EXTENSION = .3 | ||
2113 | 2107 | |||
2114 | 2108 | # The MAN_SUBDIR tag determines the name of the directory created within | ||
2115 | 2109 | # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by | ||
2116 | 2110 | # MAN_EXTENSION with the initial . removed. | ||
2117 | 2111 | # This tag requires that the tag GENERATE_MAN is set to YES. | ||
2118 | 2112 | |||
2119 | 2113 | MAN_SUBDIR = | ||
2120 | 2114 | |||
2121 | 2115 | # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it | ||
2122 | 2116 | # will generate one additional man file for each entity documented in the real | ||
2123 | 2117 | # man page(s). These additional files only source the real man page, but without | ||
2124 | 2118 | # them the man command would be unable to find the correct page. | ||
2125 | 2119 | # The default value is: NO. | ||
2126 | 2120 | # This tag requires that the tag GENERATE_MAN is set to YES. | ||
2127 | 2121 | |||
2128 | 2122 | MAN_LINKS = NO | ||
2129 | 2123 | |||
2130 | 2124 | #--------------------------------------------------------------------------- | ||
2131 | 2125 | # Configuration options related to the XML output | ||
2132 | 2126 | #--------------------------------------------------------------------------- | ||
2133 | 2127 | |||
2134 | 2128 | # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that | ||
2135 | 2129 | # captures the structure of the code including all documentation. | ||
2136 | 2130 | # The default value is: NO. | ||
2137 | 2131 | |||
2138 | 2132 | GENERATE_XML = YES | ||
2139 | 2133 | |||
2140 | 2134 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a | ||
2141 | 2135 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||
2142 | 2136 | # it. | ||
2143 | 2137 | # The default directory is: xml. | ||
2144 | 2138 | # This tag requires that the tag GENERATE_XML is set to YES. | ||
2145 | 2139 | |||
2146 | 2140 | XML_OUTPUT = doxyxml | ||
2147 | 2141 | |||
2148 | 2142 | # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program | ||
2149 | 2143 | # listings (including syntax highlighting and cross-referencing information) to | ||
2150 | 2144 | # the XML output. Note that enabling this will significantly increase the size | ||
2151 | 2145 | # of the XML output. | ||
2152 | 2146 | # The default value is: YES. | ||
2153 | 2147 | # This tag requires that the tag GENERATE_XML is set to YES. | ||
2154 | 2148 | |||
2155 | 2149 | XML_PROGRAMLISTING = YES | ||
2156 | 2150 | |||
2157 | 2151 | # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include | ||
2158 | 2152 | # namespace members in file scope as well, matching the HTML output. | ||
2159 | 2153 | # The default value is: NO. | ||
2160 | 2154 | # This tag requires that the tag GENERATE_XML is set to YES. | ||
2161 | 2155 | |||
2162 | 2156 | XML_NS_MEMB_FILE_SCOPE = NO | ||
2163 | 2157 | |||
2164 | 2158 | #--------------------------------------------------------------------------- | ||
2165 | 2159 | # Configuration options related to the DOCBOOK output | ||
2166 | 2160 | #--------------------------------------------------------------------------- | ||
2167 | 2161 | |||
2168 | 2162 | # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files | ||
2169 | 2163 | # that can be used to generate PDF. | ||
2170 | 2164 | # The default value is: NO. | ||
2171 | 2165 | |||
2172 | 2166 | GENERATE_DOCBOOK = NO | ||
2173 | 2167 | |||
2174 | 2168 | # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. | ||
2175 | 2169 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in | ||
2176 | 2170 | # front of it. | ||
2177 | 2171 | # The default directory is: docbook. | ||
2178 | 2172 | # This tag requires that the tag GENERATE_DOCBOOK is set to YES. | ||
2179 | 2173 | |||
2180 | 2174 | DOCBOOK_OUTPUT = docbook | ||
2181 | 2175 | |||
2182 | 2176 | #--------------------------------------------------------------------------- | ||
2183 | 2177 | # Configuration options for the AutoGen Definitions output | ||
2184 | 2178 | #--------------------------------------------------------------------------- | ||
2185 | 2179 | |||
2186 | 2180 | # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an | ||
2187 | 2181 | # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures | ||
2188 | 2182 | # the structure of the code including all documentation. Note that this feature | ||
2189 | 2183 | # is still experimental and incomplete at the moment. | ||
2190 | 2184 | # The default value is: NO. | ||
2191 | 2185 | |||
2192 | 2186 | GENERATE_AUTOGEN_DEF = NO | ||
2193 | 2187 | |||
2194 | 2188 | #--------------------------------------------------------------------------- | ||
2195 | 2189 | # Configuration options related to the Perl module output | ||
2196 | 2190 | #--------------------------------------------------------------------------- | ||
2197 | 2191 | |||
2198 | 2192 | # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module | ||
2199 | 2193 | # file that captures the structure of the code including all documentation. | ||
2200 | 2194 | # | ||
2201 | 2195 | # Note that this feature is still experimental and incomplete at the moment. | ||
2202 | 2196 | # The default value is: NO. | ||
2203 | 2197 | |||
2204 | 2198 | GENERATE_PERLMOD = NO | ||
2205 | 2199 | |||
2206 | 2200 | # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary | ||
2207 | 2201 | # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI | ||
2208 | 2202 | # output from the Perl module output. | ||
2209 | 2203 | # The default value is: NO. | ||
2210 | 2204 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||
2211 | 2205 | |||
2212 | 2206 | PERLMOD_LATEX = NO | ||
2213 | 2207 | |||
2214 | 2208 | # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely | ||
2215 | 2209 | # formatted so it can be parsed by a human reader. This is useful if you want to | ||
2216 | 2210 | # understand what is going on. On the other hand, if this tag is set to NO, the | ||
2217 | 2211 | # size of the Perl module output will be much smaller and Perl will parse it | ||
2218 | 2212 | # just the same. | ||
2219 | 2213 | # The default value is: YES. | ||
2220 | 2214 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||
2221 | 2215 | |||
2222 | 2216 | PERLMOD_PRETTY = YES | ||
2223 | 2217 | |||
2224 | 2218 | # The names of the make variables in the generated doxyrules.make file are | ||
2225 | 2219 | # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful | ||
2226 | 2220 | # so different doxyrules.make files included by the same Makefile don't | ||
2227 | 2221 | # overwrite each other's variables. | ||
2228 | 2222 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. | ||
2229 | 2223 | |||
2230 | 2224 | PERLMOD_MAKEVAR_PREFIX = | ||
2231 | 2225 | |||
2232 | 2226 | #--------------------------------------------------------------------------- | ||
2233 | 2227 | # Configuration options related to the preprocessor | ||
2234 | 2228 | #--------------------------------------------------------------------------- | ||
2235 | 2229 | |||
2236 | 2230 | # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all | ||
2237 | 2231 | # C-preprocessor directives found in the sources and include files. | ||
2238 | 2232 | # The default value is: YES. | ||
2239 | 2233 | |||
2240 | 2234 | ENABLE_PREPROCESSING = YES | ||
2241 | 2235 | |||
2242 | 2236 | # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names | ||
2243 | 2237 | # in the source code. If set to NO, only conditional compilation will be | ||
2244 | 2238 | # performed. Macro expansion can be done in a controlled way by setting | ||
2245 | 2239 | # EXPAND_ONLY_PREDEF to YES. | ||
2246 | 2240 | # The default value is: NO. | ||
2247 | 2241 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
2248 | 2242 | |||
2249 | 2243 | MACRO_EXPANSION = NO | ||
2250 | 2244 | |||
2251 | 2245 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then | ||
2252 | 2246 | # the macro expansion is limited to the macros specified with the PREDEFINED and | ||
2253 | 2247 | # EXPAND_AS_DEFINED tags. | ||
2254 | 2248 | # The default value is: NO. | ||
2255 | 2249 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
2256 | 2250 | |||
2257 | 2251 | EXPAND_ONLY_PREDEF = NO | ||
2258 | 2252 | |||
2259 | 2253 | # If the SEARCH_INCLUDES tag is set to YES, the include files in the | ||
2260 | 2254 | # INCLUDE_PATH will be searched if a #include is found. | ||
2261 | 2255 | # The default value is: YES. | ||
2262 | 2256 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
2263 | 2257 | |||
2264 | 2258 | SEARCH_INCLUDES = YES | ||
2265 | 2259 | |||
2266 | 2260 | # The INCLUDE_PATH tag can be used to specify one or more directories that | ||
2267 | 2261 | # contain include files that are not input files but should be processed by the | ||
2268 | 2262 | # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of | ||
2269 | 2263 | # RECURSIVE has no effect here. | ||
2270 | 2264 | # This tag requires that the tag SEARCH_INCLUDES is set to YES. | ||
2271 | 2265 | |||
2272 | 2266 | INCLUDE_PATH = | ||
2273 | 2267 | |||
2274 | 2268 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | ||
2275 | 2269 | # patterns (like *.h and *.hpp) to filter out the header-files in the | ||
2276 | 2270 | # directories. If left blank, the patterns specified with FILE_PATTERNS will be | ||
2277 | 2271 | # used. | ||
2278 | 2272 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
2279 | 2273 | |||
2280 | 2274 | INCLUDE_FILE_PATTERNS = | ||
2281 | 2275 | |||
2282 | 2276 | # The PREDEFINED tag can be used to specify one or more macro names that are | ||
2283 | 2277 | # defined before the preprocessor is started (similar to the -D option of e.g. | ||
2284 | 2278 | # gcc). The argument of the tag is a list of macros of the form: name or | ||
2285 | 2279 | # name=definition (no spaces). If the definition and the "=" are omitted, "=1" | ||
2286 | 2280 | # is assumed. To prevent a macro definition from being undefined via #undef or | ||
2287 | 2281 | # recursively expanded use the := operator instead of the = operator. | ||
2288 | 2282 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
2289 | 2283 | |||
2290 | 2284 | PREDEFINED = | ||
2291 | 2285 | |||
2292 | 2286 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this | ||
2293 | 2287 | # tag can be used to specify a list of macro names that should be expanded. The | ||
2294 | 2288 | # macro definition that is found in the sources will be used. Use the PREDEFINED | ||
2295 | 2289 | # tag if you want to use a different macro definition that overrules the | ||
2296 | 2290 | # definition found in the source code. | ||
2297 | 2291 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
2298 | 2292 | |||
2299 | 2293 | EXPAND_AS_DEFINED = | ||
2300 | 2294 | |||
2301 | 2295 | # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will | ||
2302 | 2296 | # remove all references to function-like macros that are alone on a line, have | ||
2303 | 2297 | # an all uppercase name, and do not end with a semicolon. Such function macros | ||
2304 | 2298 | # are typically used for boiler-plate code, and will confuse the parser if not | ||
2305 | 2299 | # removed. | ||
2306 | 2300 | # The default value is: YES. | ||
2307 | 2301 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||
2308 | 2302 | |||
2309 | 2303 | SKIP_FUNCTION_MACROS = YES | ||
2310 | 2304 | |||
2311 | 2305 | #--------------------------------------------------------------------------- | ||
2312 | 2306 | # Configuration options related to external references | ||
2313 | 2307 | #--------------------------------------------------------------------------- | ||
2314 | 2308 | |||
2315 | 2309 | # The TAGFILES tag can be used to specify one or more tag files. For each tag | ||
2316 | 2310 | # file the location of the external documentation should be added. The format of | ||
2317 | 2311 | # a tag file without this location is as follows: | ||
2318 | 2312 | # TAGFILES = file1 file2 ... | ||
2319 | 2313 | # Adding location for the tag files is done as follows: | ||
2320 | 2314 | # TAGFILES = file1=loc1 "file2 = loc2" ... | ||
2321 | 2315 | # where loc1 and loc2 can be relative or absolute paths or URLs. See the | ||
2322 | 2316 | # section "Linking to external documentation" for more information about the use | ||
2323 | 2317 | # of tag files. | ||
2324 | 2318 | # Note: Each tag file must have a unique name (where the name does NOT include | ||
2325 | 2319 | # the path). If a tag file is not located in the directory in which doxygen is | ||
2326 | 2320 | # run, you must also specify the path to the tagfile here. | ||
2327 | 2321 | |||
2328 | 2322 | TAGFILES = | ||
2329 | 2323 | |||
2330 | 2324 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create a | ||
2331 | 2325 | # tag file that is based on the input files it reads. See section "Linking to | ||
2332 | 2326 | # external documentation" for more information about the usage of tag files. | ||
2333 | 2327 | |||
2334 | 2328 | GENERATE_TAGFILE = | ||
2335 | 2329 | |||
2336 | 2330 | # If the ALLEXTERNALS tag is set to YES, all external class will be listed in | ||
2337 | 2331 | # the class index. If set to NO, only the inherited external classes will be | ||
2338 | 2332 | # listed. | ||
2339 | 2333 | # The default value is: NO. | ||
2340 | 2334 | |||
2341 | 2335 | ALLEXTERNALS = NO | ||
2342 | 2336 | |||
2343 | 2337 | # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed | ||
2344 | 2338 | # in the modules index. If set to NO, only the current project's groups will be | ||
2345 | 2339 | # listed. | ||
2346 | 2340 | # The default value is: YES. | ||
2347 | 2341 | |||
2348 | 2342 | EXTERNAL_GROUPS = YES | ||
2349 | 2343 | |||
2350 | 2344 | # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in | ||
2351 | 2345 | # the related pages index. If set to NO, only the current project's pages will | ||
2352 | 2346 | # be listed. | ||
2353 | 2347 | # The default value is: YES. | ||
2354 | 2348 | |||
2355 | 2349 | EXTERNAL_PAGES = YES | ||
2356 | 2350 | |||
2357 | 2351 | #--------------------------------------------------------------------------- | ||
2358 | 2352 | # Configuration options related to the dot tool | ||
2359 | 2353 | #--------------------------------------------------------------------------- | ||
2360 | 2354 | |||
2361 | 2355 | # You can include diagrams made with dia in doxygen documentation. Doxygen will | ||
2362 | 2356 | # then run dia to produce the diagram and insert it in the documentation. The | ||
2363 | 2357 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. | ||
2364 | 2358 | # If left empty dia is assumed to be found in the default search path. | ||
2365 | 2359 | |||
2366 | 2360 | DIA_PATH = | ||
2367 | 2361 | |||
2368 | 2362 | # If set to YES the inheritance and collaboration graphs will hide inheritance | ||
2369 | 2363 | # and usage relations if the target is undocumented or is not a class. | ||
2370 | 2364 | # The default value is: YES. | ||
2371 | 2365 | |||
2372 | 2366 | HIDE_UNDOC_RELATIONS = YES | ||
2373 | 2367 | |||
2374 | 2368 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | ||
2375 | 2369 | # available from the path. This tool is part of Graphviz (see: | ||
2376 | 2370 | # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent | ||
2377 | 2371 | # Bell Labs. The other options in this section have no effect if this option is | ||
2378 | 2372 | # set to NO | ||
2379 | 2373 | # The default value is: YES. | ||
2380 | 2374 | |||
2381 | 2375 | HAVE_DOT = YES | ||
2382 | 2376 | |||
2383 | 2377 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed | ||
2384 | 2378 | # to run in parallel. When set to 0 doxygen will base this on the number of | ||
2385 | 2379 | # processors available in the system. You can set it explicitly to a value | ||
2386 | 2380 | # larger than 0 to get control over the balance between CPU load and processing | ||
2387 | 2381 | # speed. | ||
2388 | 2382 | # Minimum value: 0, maximum value: 32, default value: 0. | ||
2389 | 2383 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2390 | 2384 | |||
2391 | 2385 | DOT_NUM_THREADS = 0 | ||
2392 | 2386 | |||
2393 | 2387 | # When you want a differently looking font in the dot files that doxygen | ||
2394 | 2388 | # generates you can specify the font name using DOT_FONTNAME. You need to make | ||
2395 | 2389 | # sure dot is able to find the font, which can be done by putting it in a | ||
2396 | 2390 | # standard location or by setting the DOTFONTPATH environment variable or by | ||
2397 | 2391 | # setting DOT_FONTPATH to the directory containing the font. | ||
2398 | 2392 | # The default value is: Helvetica. | ||
2399 | 2393 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2400 | 2394 | |||
2401 | 2395 | DOT_FONTNAME = Helvetica | ||
2402 | 2396 | |||
2403 | 2397 | # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of | ||
2404 | 2398 | # dot graphs. | ||
2405 | 2399 | # Minimum value: 4, maximum value: 24, default value: 10. | ||
2406 | 2400 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2407 | 2401 | |||
2408 | 2402 | DOT_FONTSIZE = 10 | ||
2409 | 2403 | |||
2410 | 2404 | # By default doxygen will tell dot to use the default font as specified with | ||
2411 | 2405 | # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set | ||
2412 | 2406 | # the path where dot can find it using this tag. | ||
2413 | 2407 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2414 | 2408 | |||
2415 | 2409 | DOT_FONTPATH = | ||
2416 | 2410 | |||
2417 | 2411 | # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a | ||
2418 | 2412 | # graph for each documented class showing the direct and indirect inheritance | ||
2419 | 2413 | # relations. In case HAVE_DOT is set as well dot will be used to draw the graph, | ||
2420 | 2414 | # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set | ||
2421 | 2415 | # to TEXT the direct and indirect inheritance relations will be shown as texts / | ||
2422 | 2416 | # links. | ||
2423 | 2417 | # Possible values are: NO, YES, TEXT and GRAPH. | ||
2424 | 2418 | # The default value is: YES. | ||
2425 | 2419 | |||
2426 | 2420 | CLASS_GRAPH = YES | ||
2427 | 2421 | |||
2428 | 2422 | # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a | ||
2429 | 2423 | # graph for each documented class showing the direct and indirect implementation | ||
2430 | 2424 | # dependencies (inheritance, containment, and class references variables) of the | ||
2431 | 2425 | # class with other documented classes. | ||
2432 | 2426 | # The default value is: YES. | ||
2433 | 2427 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2434 | 2428 | |||
2435 | 2429 | COLLABORATION_GRAPH = YES | ||
2436 | 2430 | |||
2437 | 2431 | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for | ||
2438 | 2432 | # groups, showing the direct groups dependencies. See also the chapter Grouping | ||
2439 | 2433 | # in the manual. | ||
2440 | 2434 | # The default value is: YES. | ||
2441 | 2435 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2442 | 2436 | |||
2443 | 2437 | GROUP_GRAPHS = YES | ||
2444 | 2438 | |||
2445 | 2439 | # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and | ||
2446 | 2440 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | ||
2447 | 2441 | # Language. | ||
2448 | 2442 | # The default value is: NO. | ||
2449 | 2443 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2450 | 2444 | |||
2451 | 2445 | UML_LOOK = NO | ||
2452 | 2446 | |||
2453 | 2447 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside the | ||
2454 | 2448 | # class node. If there are many fields or methods and many nodes the graph may | ||
2455 | 2449 | # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the | ||
2456 | 2450 | # number of items for each type to make the size more manageable. Set this to 0 | ||
2457 | 2451 | # for no limit. Note that the threshold may be exceeded by 50% before the limit | ||
2458 | 2452 | # is enforced. So when you set the threshold to 10, up to 15 fields may appear, | ||
2459 | 2453 | # but if the number exceeds 15, the total amount of fields shown is limited to | ||
2460 | 2454 | # 10. | ||
2461 | 2455 | # Minimum value: 0, maximum value: 100, default value: 10. | ||
2462 | 2456 | # This tag requires that the tag UML_LOOK is set to YES. | ||
2463 | 2457 | |||
2464 | 2458 | UML_LIMIT_NUM_FIELDS = 10 | ||
2465 | 2459 | |||
2466 | 2460 | # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and | ||
2467 | 2461 | # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS | ||
2468 | 2462 | # tag is set to YES, doxygen will add type and arguments for attributes and | ||
2469 | 2463 | # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen | ||
2470 | 2464 | # will not generate fields with class member information in the UML graphs. The | ||
2471 | 2465 | # class diagrams will look similar to the default class diagrams but using UML | ||
2472 | 2466 | # notation for the relationships. | ||
2473 | 2467 | # Possible values are: NO, YES and NONE. | ||
2474 | 2468 | # The default value is: NO. | ||
2475 | 2469 | # This tag requires that the tag UML_LOOK is set to YES. | ||
2476 | 2470 | |||
2477 | 2471 | DOT_UML_DETAILS = NO | ||
2478 | 2472 | |||
2479 | 2473 | # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters | ||
2480 | 2474 | # to display on a single line. If the actual line length exceeds this threshold | ||
2481 | 2475 | # significantly it will wrapped across multiple lines. Some heuristics are apply | ||
2482 | 2476 | # to avoid ugly line breaks. | ||
2483 | 2477 | # Minimum value: 0, maximum value: 1000, default value: 17. | ||
2484 | 2478 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2485 | 2479 | |||
2486 | 2480 | DOT_WRAP_THRESHOLD = 17 | ||
2487 | 2481 | |||
2488 | 2482 | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and | ||
2489 | 2483 | # collaboration graphs will show the relations between templates and their | ||
2490 | 2484 | # instances. | ||
2491 | 2485 | # The default value is: NO. | ||
2492 | 2486 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2493 | 2487 | |||
2494 | 2488 | TEMPLATE_RELATIONS = NO | ||
2495 | 2489 | |||
2496 | 2490 | # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to | ||
2497 | 2491 | # YES then doxygen will generate a graph for each documented file showing the | ||
2498 | 2492 | # direct and indirect include dependencies of the file with other documented | ||
2499 | 2493 | # files. | ||
2500 | 2494 | # The default value is: YES. | ||
2501 | 2495 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2502 | 2496 | |||
2503 | 2497 | INCLUDE_GRAPH = YES | ||
2504 | 2498 | |||
2505 | 2499 | # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are | ||
2506 | 2500 | # set to YES then doxygen will generate a graph for each documented file showing | ||
2507 | 2501 | # the direct and indirect include dependencies of the file with other documented | ||
2508 | 2502 | # files. | ||
2509 | 2503 | # The default value is: YES. | ||
2510 | 2504 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2511 | 2505 | |||
2512 | 2506 | INCLUDED_BY_GRAPH = YES | ||
2513 | 2507 | |||
2514 | 2508 | # If the CALL_GRAPH tag is set to YES then doxygen will generate a call | ||
2515 | 2509 | # dependency graph for every global function or class method. | ||
2516 | 2510 | # | ||
2517 | 2511 | # Note that enabling this option will significantly increase the time of a run. | ||
2518 | 2512 | # So in most cases it will be better to enable call graphs for selected | ||
2519 | 2513 | # functions only using the \callgraph command. Disabling a call graph can be | ||
2520 | 2514 | # accomplished by means of the command \hidecallgraph. | ||
2521 | 2515 | # The default value is: NO. | ||
2522 | 2516 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2523 | 2517 | |||
2524 | 2518 | CALL_GRAPH = NO | ||
2525 | 2519 | |||
2526 | 2520 | # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller | ||
2527 | 2521 | # dependency graph for every global function or class method. | ||
2528 | 2522 | # | ||
2529 | 2523 | # Note that enabling this option will significantly increase the time of a run. | ||
2530 | 2524 | # So in most cases it will be better to enable caller graphs for selected | ||
2531 | 2525 | # functions only using the \callergraph command. Disabling a caller graph can be | ||
2532 | 2526 | # accomplished by means of the command \hidecallergraph. | ||
2533 | 2527 | # The default value is: NO. | ||
2534 | 2528 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2535 | 2529 | |||
2536 | 2530 | CALLER_GRAPH = NO | ||
2537 | 2531 | |||
2538 | 2532 | # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical | ||
2539 | 2533 | # hierarchy of all classes instead of a textual one. | ||
2540 | 2534 | # The default value is: YES. | ||
2541 | 2535 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2542 | 2536 | |||
2543 | 2537 | GRAPHICAL_HIERARCHY = YES | ||
2544 | 2538 | |||
2545 | 2539 | # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the | ||
2546 | 2540 | # dependencies a directory has on other directories in a graphical way. The | ||
2547 | 2541 | # dependency relations are determined by the #include relations between the | ||
2548 | 2542 | # files in the directories. | ||
2549 | 2543 | # The default value is: YES. | ||
2550 | 2544 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2551 | 2545 | |||
2552 | 2546 | DIRECTORY_GRAPH = YES | ||
2553 | 2547 | |||
2554 | 2548 | # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels | ||
2555 | 2549 | # of child directories generated in directory dependency graphs by dot. | ||
2556 | 2550 | # Minimum value: 1, maximum value: 25, default value: 1. | ||
2557 | 2551 | # This tag requires that the tag DIRECTORY_GRAPH is set to YES. | ||
2558 | 2552 | |||
2559 | 2553 | DIR_GRAPH_MAX_DEPTH = 1 | ||
2560 | 2554 | |||
2561 | 2555 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | ||
2562 | 2556 | # generated by dot. For an explanation of the image formats see the section | ||
2563 | 2557 | # output formats in the documentation of the dot tool (Graphviz (see: | ||
2564 | 2558 | # http://www.graphviz.org/)). | ||
2565 | 2559 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order | ||
2566 | 2560 | # to make the SVG files visible in IE 9+ (other browsers do not have this | ||
2567 | 2561 | # requirement). | ||
2568 | 2562 | # Possible values are: png, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, | ||
2569 | 2563 | # gif, gif:cairo, gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, | ||
2570 | 2564 | # png:cairo, png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and | ||
2571 | 2565 | # png:gdiplus:gdiplus. | ||
2572 | 2566 | # The default value is: png. | ||
2573 | 2567 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2574 | 2568 | |||
2575 | 2569 | DOT_IMAGE_FORMAT = png | ||
2576 | 2570 | |||
2577 | 2571 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to | ||
2578 | 2572 | # enable generation of interactive SVG images that allow zooming and panning. | ||
2579 | 2573 | # | ||
2580 | 2574 | # Note that this requires a modern browser other than Internet Explorer. Tested | ||
2581 | 2575 | # and working are Firefox, Chrome, Safari, and Opera. | ||
2582 | 2576 | # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make | ||
2583 | 2577 | # the SVG files visible. Older versions of IE do not have SVG support. | ||
2584 | 2578 | # The default value is: NO. | ||
2585 | 2579 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2586 | 2580 | |||
2587 | 2581 | INTERACTIVE_SVG = NO | ||
2588 | 2582 | |||
2589 | 2583 | # The DOT_PATH tag can be used to specify the path where the dot tool can be | ||
2590 | 2584 | # found. If left blank, it is assumed the dot tool can be found in the path. | ||
2591 | 2585 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2592 | 2586 | |||
2593 | 2587 | DOT_PATH = | ||
2594 | 2588 | |||
2595 | 2589 | # The DOTFILE_DIRS tag can be used to specify one or more directories that | ||
2596 | 2590 | # contain dot files that are included in the documentation (see the \dotfile | ||
2597 | 2591 | # command). | ||
2598 | 2592 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2599 | 2593 | |||
2600 | 2594 | DOTFILE_DIRS = | ||
2601 | 2595 | |||
2602 | 2596 | # The MSCFILE_DIRS tag can be used to specify one or more directories that | ||
2603 | 2597 | # contain msc files that are included in the documentation (see the \mscfile | ||
2604 | 2598 | # command). | ||
2605 | 2599 | |||
2606 | 2600 | MSCFILE_DIRS = | ||
2607 | 2601 | |||
2608 | 2602 | # The DIAFILE_DIRS tag can be used to specify one or more directories that | ||
2609 | 2603 | # contain dia files that are included in the documentation (see the \diafile | ||
2610 | 2604 | # command). | ||
2611 | 2605 | |||
2612 | 2606 | DIAFILE_DIRS = | ||
2613 | 2607 | |||
2614 | 2608 | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the | ||
2615 | 2609 | # path where java can find the plantuml.jar file or to the filename of jar file | ||
2616 | 2610 | # to be used. If left blank, it is assumed PlantUML is not used or called during | ||
2617 | 2611 | # a preprocessing step. Doxygen will generate a warning when it encounters a | ||
2618 | 2612 | # \startuml command in this case and will not generate output for the diagram. | ||
2619 | 2613 | |||
2620 | 2614 | PLANTUML_JAR_PATH = | ||
2621 | 2615 | |||
2622 | 2616 | # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a | ||
2623 | 2617 | # configuration file for plantuml. | ||
2624 | 2618 | |||
2625 | 2619 | PLANTUML_CFG_FILE = | ||
2626 | 2620 | |||
2627 | 2621 | # When using plantuml, the specified paths are searched for files specified by | ||
2628 | 2622 | # the !include statement in a plantuml block. | ||
2629 | 2623 | |||
2630 | 2624 | PLANTUML_INCLUDE_PATH = | ||
2631 | 2625 | |||
2632 | 2626 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes | ||
2633 | 2627 | # that will be shown in the graph. If the number of nodes in a graph becomes | ||
2634 | 2628 | # larger than this value, doxygen will truncate the graph, which is visualized | ||
2635 | 2629 | # by representing a node as a red box. Note that doxygen if the number of direct | ||
2636 | 2630 | # children of the root node in a graph is already larger than | ||
2637 | 2631 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that | ||
2638 | 2632 | # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | ||
2639 | 2633 | # Minimum value: 0, maximum value: 10000, default value: 50. | ||
2640 | 2634 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2641 | 2635 | |||
2642 | 2636 | DOT_GRAPH_MAX_NODES = 50 | ||
2643 | 2637 | |||
2644 | 2638 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs | ||
2645 | 2639 | # generated by dot. A depth value of 3 means that only nodes reachable from the | ||
2646 | 2640 | # root by following a path via at most 3 edges will be shown. Nodes that lay | ||
2647 | 2641 | # further from the root node will be omitted. Note that setting this option to 1 | ||
2648 | 2642 | # or 2 may greatly reduce the computation time needed for large code bases. Also | ||
2649 | 2643 | # note that the size of a graph can be further restricted by | ||
2650 | 2644 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | ||
2651 | 2645 | # Minimum value: 0, maximum value: 1000, default value: 0. | ||
2652 | 2646 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2653 | 2647 | |||
2654 | 2648 | MAX_DOT_GRAPH_DEPTH = 0 | ||
2655 | 2649 | |||
2656 | 2650 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | ||
2657 | 2651 | # background. This is disabled by default, because dot on Windows does not seem | ||
2658 | 2652 | # to support this out of the box. | ||
2659 | 2653 | # | ||
2660 | 2654 | # Warning: Depending on the platform used, enabling this option may lead to | ||
2661 | 2655 | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to | ||
2662 | 2656 | # read). | ||
2663 | 2657 | # The default value is: NO. | ||
2664 | 2658 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2665 | 2659 | |||
2666 | 2660 | DOT_TRANSPARENT = NO | ||
2667 | 2661 | |||
2668 | 2662 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output | ||
2669 | 2663 | # files in one run (i.e. multiple -o and -T options on the command line). This | ||
2670 | 2664 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support | ||
2671 | 2665 | # this, this feature is disabled by default. | ||
2672 | 2666 | # The default value is: NO. | ||
2673 | 2667 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2674 | 2668 | |||
2675 | 2669 | DOT_MULTI_TARGETS = NO | ||
2676 | 2670 | |||
2677 | 2671 | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page | ||
2678 | 2672 | # explaining the meaning of the various boxes and arrows in the dot generated | ||
2679 | 2673 | # graphs. | ||
2680 | 2674 | # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal | ||
2681 | 2675 | # graphical representation for inheritance and collaboration diagrams is used. | ||
2682 | 2676 | # The default value is: YES. | ||
2683 | 2677 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2684 | 2678 | |||
2685 | 2679 | GENERATE_LEGEND = YES | ||
2686 | 2680 | |||
2687 | 2681 | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate | ||
2688 | 2682 | # files that are used to generate the various graphs. | ||
2689 | 2683 | # | ||
2690 | 2684 | # Note: This setting is not only used for dot files but also for msc temporary | ||
2691 | 2685 | # files. | ||
2692 | 2686 | # The default value is: YES. | ||
2693 | 2687 | |||
2694 | 2688 | DOT_CLEANUP = YES | ||
2695 | diff --git a/debian/changelog b/debian/changelog | |||
2696 | index 6774ec3..180b2d4 100644 | |||
2697 | --- a/debian/changelog | |||
2698 | +++ b/debian/changelog | |||
2699 | @@ -1,3 +1,72 @@ | |||
2700 | 1 | netplan.io (0.107.1-3ubuntu0.23.10.1) mantic; urgency=medium | ||
2701 | 2 | |||
2702 | 3 | * Backport netplan.io 0.107.1-3 to 23.10 (LP: #2058051): | ||
2703 | 4 | - wifi: add support for WPA3-Enterprise (LP: #2029876) (!402) | ||
2704 | 5 | - wifi: support WPA2 and WPA3 Personal simultaneously (!404) | ||
2705 | 6 | - added mii-monitor-interval example (!411) | ||
2706 | 7 | - docs: Add "Contribute Documentation" how-to | ||
2707 | 8 | - auth: add support for LEAP and EAP-PWD (!415) | ||
2708 | 9 | - tests: Add autopkgtest for (LP: #1959570) (!419) | ||
2709 | 10 | - wifi: make it possible to have a psk and an eap password simultaneously | ||
2710 | 11 | (!416) | ||
2711 | 12 | - doc: Set-up some basic Doxygen project (!423) | ||
2712 | 13 | - doc: Make Sphinx to handle autodoxygen project, using breathe (!423) | ||
2713 | 14 | - doc: create libnetplan apidoc structure (!423) | ||
2714 | 15 | - inc: Start documenting public API (!423) | ||
2715 | 16 | - doc: Update 'Netplan everywhere' for 23.10 (!418) | ||
2716 | 17 | Bug fixes: | ||
2717 | 18 | - test:ovs: Avoid NetworkManager taking contol, breaking a test | ||
2718 | 19 | - parse: allow COMMON_LINK_HANDLERS for VRFs (!401) | ||
2719 | 20 | - util: don't return a placeholder netdef in the iterator (!406) | ||
2720 | 21 | - tunnels/validation: do not error out if "local" is not defined (!407) | ||
2721 | 22 | - tests: add some integration tests without the local address (!407) | ||
2722 | 23 | - wireguard: ignore empty endpoints (LP: #2038811) (!414) | ||
2723 | 24 | - parse: improve the parsing of access-points (LP: #1809994) (!413) | ||
2724 | 25 | - wifi: replace the previously defined AP with the new one (!413) | ||
2725 | 26 | - doc: spelling check improvements (!417) | ||
2726 | 27 | - Fix permissions on folder '/run/NetworkManager/' (!422) | ||
2727 | 28 | - cli:try: avoid linting error for type hints (Closes: #1058524) (!422) | ||
2728 | 29 | - nm-parse: always read the PSK into the new psk variable (!416) | ||
2729 | 30 | - networkd: fix formatting (!424) | ||
2730 | 31 | - networkd: replace deprecated CriticalConnection= by KeepConfiguration= | ||
2731 | 32 | (!424) | ||
2732 | 33 | - networkd: move KeepConfiguration= into [Network] section | ||
2733 | 34 | - apply: bring "lo" back up if it's managed by NM (!408) | ||
2734 | 35 | - apply: don't assume the NM loopback connection is called "lo" (!408) | ||
2735 | 36 | * Drop patches merged upstream: | ||
2736 | 37 | - lp1809994/0010-parse-improve-the-parsing-of-access-points-LP-180999.patch | ||
2737 | 38 | - lp1809994/0011-wifi-replace-the-previously-defined-AP-with-the-new-.patch | ||
2738 | 39 | - lp2039821/0008-wireguard-ignore-empty-endpoints.patch | ||
2739 | 40 | - lp2039825/0009-auth-add-support-for-LEAP-and-EAP-PWD.patch | ||
2740 | 41 | * Add patches for bug fixes from netplan.io 1.0-1: | ||
2741 | 42 | - lp2041727/0004-cli-utils-introduce-systemctl_is_installed-helper.patch | ||
2742 | 43 | cli:utils: introduce systemctl_is_installed helper (LP: #2041727) (!421) | ||
2743 | 44 | - lp2041727/0005-Update-ovs.py-to-check-if-ovsdb-server.service-is-in.patch | ||
2744 | 45 | Check if ovsdb-server.service is active before displaying warning | ||
2745 | 46 | (LP: #2041727) (!421) | ||
2746 | 47 | - d/p/0007-tests-assert-generated-.service-files-in-assert_srio.patch, | ||
2747 | 48 | d/p/0008-tests-sriov-test-if-the-generated-netplan-rebind-ser.patch, | ||
2748 | 49 | d/p/0009-sriov-don-t-generate-duplicate-entries-in-the-rebind.patch: | ||
2749 | 50 | Don't generate duplicate entries in the netplan-sriov-rebind.service | ||
2750 | 51 | (!437) | ||
2751 | 52 | * Drop patches not required for 23.10: | ||
2752 | 53 | - debian/patches/python-limited-stable-api.patch | ||
2753 | 54 | * debian/netplan.io.preinst: | ||
2754 | 55 | - This preinst script is intended to cleanup the .pyc files from | ||
2755 | 56 | share/netplan/netplan. This directory is supposed to be removed after | ||
2756 | 57 | the upgrade from netplan.io 0.106.1 to 0.107, as the Python code | ||
2757 | 58 | was moved to it's own python3-netplan package, but it's left behind | ||
2758 | 59 | due to Python cached files. | ||
2759 | 60 | * Drop changes related to usr-merge and not required for 23.10: | ||
2760 | 61 | - debian/netplan-generator.dirs | ||
2761 | 62 | - debian/netplan-generator.install | ||
2762 | 63 | - debian/netplan-generator.postinst | ||
2763 | 64 | - debian/netplan-generator.preinst | ||
2764 | 65 | * debian/netplan-generator.lintian-overrides: | ||
2765 | 66 | - Drop overrides file. It wasn't really silencing any lintian warnings. | ||
2766 | 67 | |||
2767 | 68 | -- Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> Wed, 13 Mar 2024 09:38:15 +0000 | ||
2768 | 69 | |||
2769 | 1 | netplan.io (0.107-5ubuntu0.2) mantic; urgency=medium | 70 | netplan.io (0.107-5ubuntu0.2) mantic; urgency=medium |
2770 | 2 | 71 | ||
2771 | 3 | * lp1809994/0010-parse-improve-the-parsing-of-access-points-LP-180999.patch: | 72 | * lp1809994/0010-parse-improve-the-parsing-of-access-points-LP-180999.patch: |
2772 | diff --git a/debian/control b/debian/control | |||
2773 | index 74d2604..bc358c7 100644 | |||
2774 | --- a/debian/control | |||
2775 | +++ b/debian/control | |||
2776 | @@ -27,7 +27,8 @@ Build-Depends: | |||
2777 | 27 | libcmocka-dev, | 27 | libcmocka-dev, |
2778 | 28 | libpython3-dev, | 28 | libpython3-dev, |
2779 | 29 | libsystemd-dev, | 29 | libsystemd-dev, |
2781 | 30 | systemd, | 30 | systemd <!nocheck>, |
2782 | 31 | systemd-dev, | ||
2783 | 31 | dbus-x11 <!nocheck>, | 32 | dbus-x11 <!nocheck>, |
2784 | 32 | pyflakes3 <!nocheck>, | 33 | pyflakes3 <!nocheck>, |
2785 | 33 | pycodestyle <!nocheck> | pep8 <!nocheck>, | 34 | pycodestyle <!nocheck> | pep8 <!nocheck>, |
2786 | diff --git a/debian/extra/PLACEHOLDER b/debian/extra/PLACEHOLDER | |||
2787 | 34 | new file mode 100644 | 35 | new file mode 100644 |
2788 | index 0000000..fb20d88 | |||
2789 | --- /dev/null | |||
2790 | +++ b/debian/extra/PLACEHOLDER | |||
2791 | @@ -0,0 +1,4 @@ | |||
2792 | 1 | This is a placeholder file to avoid an empty [/usr]/lib/netplan/ directory | ||
2793 | 2 | to be removed during a package upgrade involving the usrmerge transition. | ||
2794 | 3 | |||
2795 | 4 | See https://bugs.debian.org/1060661 for more context. | ||
2796 | diff --git a/debian/netplan-generator.lintian-overrides b/debian/netplan-generator.lintian-overrides | |||
2797 | 0 | deleted file mode 100644 | 5 | deleted file mode 100644 |
2798 | index 7225e61..0000000 | |||
2799 | --- a/debian/netplan-generator.lintian-overrides | |||
2800 | +++ /dev/null | |||
2801 | @@ -1,2 +0,0 @@ | |||
2802 | 1 | # false positive | ||
2803 | 2 | netplan-generator: package-contains-empty-directory [usr/lib/netplan/] | ||
2804 | diff --git a/debian/netplan.io.preinst b/debian/netplan.io.preinst | |||
2805 | 3 | new file mode 100644 | 0 | new file mode 100644 |
2806 | index 0000000..9a508f1 | |||
2807 | --- /dev/null | |||
2808 | +++ b/debian/netplan.io.preinst | |||
2809 | @@ -0,0 +1,17 @@ | |||
2810 | 1 | #!/bin/sh | ||
2811 | 2 | |||
2812 | 3 | set -e | ||
2813 | 4 | |||
2814 | 5 | # Cleanup .pyc cached files from netplan.io versions older than 0.107-3. | ||
2815 | 6 | # After 0.107-3, the noncli-related code was moved away from | ||
2816 | 7 | # share/netplan/netplan, thanks to the new python3-netplan package, | ||
2817 | 8 | # but dpkg would leave this directory behind due to the .pyc files. | ||
2818 | 9 | # Cleaning it up here will leave the directory empty so dpkg will remove | ||
2819 | 10 | # it properly during the update process. | ||
2820 | 11 | |||
2821 | 12 | if [ -d /usr/share/netplan/netplan ]; then | ||
2822 | 13 | find /usr/share/netplan/netplan/ -name '*.pyc' -delete | ||
2823 | 14 | find /usr/share/netplan/netplan/ -name '__pycache__' -delete | ||
2824 | 15 | fi | ||
2825 | 16 | |||
2826 | 17 | #DEBHELPER# | ||
2827 | diff --git a/debian/patches/0001-parse-allow-COMMON_LINK_HANDLERS-for-VRFs-LP-2031421.patch b/debian/patches/0001-parse-allow-COMMON_LINK_HANDLERS-for-VRFs-LP-2031421.patch | |||
2828 | 0 | deleted file mode 100644 | 18 | deleted file mode 100644 |
2829 | index ea670f6..0000000 | |||
2830 | --- a/debian/patches/0001-parse-allow-COMMON_LINK_HANDLERS-for-VRFs-LP-2031421.patch | |||
2831 | +++ /dev/null | |||
2832 | @@ -1,41 +0,0 @@ | |||
2833 | 1 | From: =?utf-8?q?Lukas_M=C3=A4rdian?= <slyon@ubuntu.com> | ||
2834 | 2 | Date: Mon, 21 Aug 2023 15:59:42 +0200 | ||
2835 | 3 | Subject: parse: allow COMMON_LINK_HANDLERS for VRFs (LP: #2031421, | ||
2836 | 4 | Closes: #1049432) | ||
2837 | 5 | |||
2838 | 6 | Bug: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1049432 | ||
2839 | 7 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2031421 | ||
2840 | 8 | Forwarded: https://github.com/canonical/netplan/pull/401 | ||
2841 | 9 | |||
2842 | 10 | This is to fix test failures with latest NetworkManager v1.44, after they | ||
2843 | 11 | slightly changed behavior: | ||
2844 | 12 | https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/commit/dabfa26a41edc7911a45a4689d555e8f055b0373 | ||
2845 | 13 | --- | ||
2846 | 14 | src/parse.c | 1 + | ||
2847 | 15 | tests/integration/routing.py | 1 + | ||
2848 | 16 | 2 files changed, 2 insertions(+) | ||
2849 | 17 | |||
2850 | 18 | diff --git a/src/parse.c b/src/parse.c | ||
2851 | 19 | index b930b75..a1730e5 100644 | ||
2852 | 20 | --- a/src/parse.c | ||
2853 | 21 | +++ b/src/parse.c | ||
2854 | 22 | @@ -2864,6 +2864,7 @@ static const mapping_entry_handler vlan_def_handlers[] = { | ||
2855 | 23 | }; | ||
2856 | 24 | |||
2857 | 25 | static const mapping_entry_handler vrf_def_handlers[] = { | ||
2858 | 26 | + COMMON_LINK_HANDLERS, | ||
2859 | 27 | COMMON_BACKEND_HANDLERS, | ||
2860 | 28 | {"renderer", YAML_SCALAR_NODE, {.generic=handle_netdef_renderer}, NULL}, | ||
2861 | 29 | {"interfaces", YAML_SEQUENCE_NODE, {.generic=handle_vrf_interfaces}, NULL}, | ||
2862 | 30 | diff --git a/tests/integration/routing.py b/tests/integration/routing.py | ||
2863 | 31 | index f29b012..f63be36 100644 | ||
2864 | 32 | --- a/tests/integration/routing.py | ||
2865 | 33 | +++ b/tests/integration/routing.py | ||
2866 | 34 | @@ -295,6 +295,7 @@ class _CommonTests(): | ||
2867 | 35 | table: 1000 | ||
2868 | 36 | vrfs: | ||
2869 | 37 | vrf0: | ||
2870 | 38 | + addresses: [10.10.10.20/24] | ||
2871 | 39 | table: 1000 | ||
2872 | 40 | interfaces: [%(ec)s] | ||
2873 | 41 | routes: | ||
2874 | diff --git a/debian/patches/0001-parse-nm-wg-append-the-correct-prefix-to-IPv6-addres.patch b/debian/patches/0001-parse-nm-wg-append-the-correct-prefix-to-IPv6-addres.patch | |||
2875 | 42 | new file mode 100644 | 0 | new file mode 100644 |
2876 | index 0000000..58ee85f | |||
2877 | --- /dev/null | |||
2878 | +++ b/debian/patches/0001-parse-nm-wg-append-the-correct-prefix-to-IPv6-addres.patch | |||
2879 | @@ -0,0 +1,77 @@ | |||
2880 | 1 | From: Danilo Egea Gondolfo <danilogondolfo@gmail.com> | ||
2881 | 2 | Date: Thu, 4 Jan 2024 14:35:43 +0000 | ||
2882 | 3 | Subject: parse-nm/wg: append the correct prefix to IPv6 addresses (#428) | ||
2883 | 4 | |||
2884 | 5 | When the prefix is omitted for IPs in the allowed-ips list, we were | ||
2885 | 6 | appending a /32 to them without checking the address family. | ||
2886 | 7 | |||
2887 | 8 | IPv6 addresses will have a /128 appended to them if it's not present. | ||
2888 | 9 | |||
2889 | 10 | See LP: #2046158 | ||
2890 | 11 | |||
2891 | 12 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/network-manager/+bug/2046158 | ||
2892 | 13 | Origin: https://github.com/canonical/netplan/pull/428 | ||
2893 | 14 | Forwarded: not-needed | ||
2894 | 15 | --- | ||
2895 | 16 | src/parse-nm.c | 15 +++++++++------ | ||
2896 | 17 | tests/parser/test_keyfile.py | 6 ++++-- | ||
2897 | 18 | 2 files changed, 13 insertions(+), 8 deletions(-) | ||
2898 | 19 | |||
2899 | 20 | diff --git a/src/parse-nm.c b/src/parse-nm.c | ||
2900 | 21 | index 2e9a264..10f1780 100644 | ||
2901 | 22 | --- a/src/parse-nm.c | ||
2902 | 23 | +++ b/src/parse-nm.c | ||
2903 | 24 | @@ -543,13 +543,16 @@ parse_tunnels(GKeyFile* kf, NetplanNetDefinition* nd) | ||
2904 | 25 | /* | ||
2905 | 26 | * NM doesn't care if the prefix was omitted. | ||
2906 | 27 | * Even though the WG manual says it requires the prefix, | ||
2907 | 28 | - * if it's omitted in its config file it will default to /32 | ||
2908 | 29 | - * so we should do the same here and append a /32 if it's not present, | ||
2909 | 30 | - * otherwise we will generate a YAML that will fail validation. | ||
2910 | 31 | + * if it's omitted in its config file it will default to /32 for IPv4 | ||
2911 | 32 | + * and /128 for IPv6 so we should do the same here and append a /32 or /128 | ||
2912 | 33 | + * if it's not present, otherwise we will generate a YAML that will fail validation. | ||
2913 | 34 | */ | ||
2914 | 35 | - if (!g_strrstr(ip, "/")) | ||
2915 | 36 | - address = g_strdup_printf("%s/32", ip); | ||
2916 | 37 | - else | ||
2917 | 38 | + if (!g_strrstr(ip, "/")) { | ||
2918 | 39 | + if (is_ip4_address(ip)) | ||
2919 | 40 | + address = g_strdup_printf("%s/32", ip); | ||
2920 | 41 | + else | ||
2921 | 42 | + address = g_strdup_printf("%s/128", ip); | ||
2922 | 43 | + } else | ||
2923 | 44 | address = g_strdup(ip); | ||
2924 | 45 | g_array_append_val(wireguard_peer->allowed_ips, address); | ||
2925 | 46 | } | ||
2926 | 47 | diff --git a/tests/parser/test_keyfile.py b/tests/parser/test_keyfile.py | ||
2927 | 48 | index ae4d8d1..1351840 100644 | ||
2928 | 49 | --- a/tests/parser/test_keyfile.py | ||
2929 | 50 | +++ b/tests/parser/test_keyfile.py | ||
2930 | 51 | @@ -1963,7 +1963,8 @@ method=auto\n'''.format(UUID), regenerate=False) | ||
2931 | 52 | |||
2932 | 53 | def test_wireguard_allowed_ips_without_prefix(self): | ||
2933 | 54 | ''' | ||
2934 | 55 | - When the IP prefix is not present we should default to /32 | ||
2935 | 56 | + When the IP prefix is not present we should default to /32 for IPv4 | ||
2936 | 57 | + and /128 for IPv6. | ||
2937 | 58 | ''' | ||
2938 | 59 | self.generate_from_keyfile('''[connection] | ||
2939 | 60 | id=wg0 | ||
2940 | 61 | @@ -1976,7 +1977,7 @@ private-key=aPUcp5vHz8yMLrzk8SsDyYnV33IhE/k20e52iKJFV0A= | ||
2941 | 62 | |||
2942 | 63 | [wireguard-peer.cwkb7k0xDgLSnunZpFIjLJw4u+mJDDr+aBR5DqzpmgI=] | ||
2943 | 64 | endpoint=1.2.3.4:12345 | ||
2944 | 65 | -allowed-ips=192.168.0.10 | ||
2945 | 66 | +allowed-ips=192.168.0.10;2001::1; | ||
2946 | 67 | |||
2947 | 68 | [ipv4] | ||
2948 | 69 | method=auto\n'''.format(UUID), regenerate=False) | ||
2949 | 70 | @@ -1995,6 +1996,7 @@ method=auto\n'''.format(UUID), regenerate=False) | ||
2950 | 71 | public: "cwkb7k0xDgLSnunZpFIjLJw4u+mJDDr+aBR5DqzpmgI=" | ||
2951 | 72 | allowed-ips: | ||
2952 | 73 | - "192.168.0.10/32" | ||
2953 | 74 | + - "2001::1/128" | ||
2954 | 75 | networkmanager: | ||
2955 | 76 | uuid: "{}" | ||
2956 | 77 | name: "wg0" | ||
2957 | diff --git a/debian/patches/0002-test-ovs-Avoid-NetworkManager-taking-contol-breaking.patch b/debian/patches/0002-test-ovs-Avoid-NetworkManager-taking-contol-breaking.patch | |||
2958 | 0 | deleted file mode 100644 | 78 | deleted file mode 100644 |
2959 | index f12a5f3..0000000 | |||
2960 | --- a/debian/patches/0002-test-ovs-Avoid-NetworkManager-taking-contol-breaking.patch | |||
2961 | +++ /dev/null | |||
2962 | @@ -1,28 +0,0 @@ | |||
2963 | 1 | From: =?utf-8?q?Lukas_M=C3=A4rdian?= <slyon@ubuntu.com> | ||
2964 | 2 | Date: Mon, 21 Aug 2023 14:56:46 +0200 | ||
2965 | 3 | Subject: test:ovs: Avoid NetworkManager taking contol, breaking a test | ||
2966 | 4 | |||
2967 | 5 | Forwarded: not-needed | ||
2968 | 6 | Origin: https://github.com/canonical/netplan/commit/c33175cbb16dd154f87b51f5ea1cb2c936564a19 | ||
2969 | 7 | --- | ||
2970 | 8 | tests/integration/ovs.py | 5 ++++- | ||
2971 | 9 | 1 file changed, 4 insertions(+), 1 deletion(-) | ||
2972 | 10 | |||
2973 | 11 | diff --git a/tests/integration/ovs.py b/tests/integration/ovs.py | ||
2974 | 12 | index 958800c..834a7bd 100644 | ||
2975 | 13 | --- a/tests/integration/ovs.py | ||
2976 | 14 | +++ b/tests/integration/ovs.py | ||
2977 | 15 | @@ -76,9 +76,12 @@ class _CommonTests(): | ||
2978 | 16 | openvswitch: | ||
2979 | 17 | ports: | ||
2980 | 18 | - [patch0-1, patch1-0] | ||
2981 | 19 | + ethernets: | ||
2982 | 20 | + # define this eth to avoid NM taking control and breaking the following .generate_and_settle() | ||
2983 | 21 | + %(ec)s: {} | ||
2984 | 22 | bridges: | ||
2985 | 23 | ovs0: {interfaces: [patch0-1]} | ||
2986 | 24 | - ovs1: {interfaces: [patch1-0]}''') | ||
2987 | 25 | + ovs1: {interfaces: [patch1-0]}''' % {'ec': self.dev_e_client}) | ||
2988 | 26 | self.generate_and_settle(['ovs0', 'ovs1']) | ||
2989 | 27 | # Basic verification that the bridges/ports/interfaces are there in OVS | ||
2990 | 28 | out = subprocess.check_output(['ovs-vsctl', '-t', '5', 'show']) | ||
2991 | diff --git a/debian/patches/0003-util-don-t-return-a-placeholder-netdef-in-the-iterat.patch b/debian/patches/0003-util-don-t-return-a-placeholder-netdef-in-the-iterat.patch | |||
2992 | 29 | deleted file mode 100644 | 0 | deleted file mode 100644 |
2993 | index dab37df..0000000 | |||
2994 | --- a/debian/patches/0003-util-don-t-return-a-placeholder-netdef-in-the-iterat.patch | |||
2995 | +++ /dev/null | |||
2996 | @@ -1,54 +0,0 @@ | |||
2997 | 1 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
2998 | 2 | Date: Thu, 31 Aug 2023 15:22:00 +0100 | ||
2999 | 3 | Subject: util: don't return a placeholder netdef in the iterator | ||
3000 | 4 | |||
3001 | 5 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2034024 | ||
3002 | 6 | Origin: https://github.com/canonical/netplan/pull/406 | ||
3003 | 7 | --- | ||
3004 | 8 | src/util.c | 2 ++ | ||
3005 | 9 | tests/test_libnetplan.py | 19 +++++++++++++++++++ | ||
3006 | 10 | 2 files changed, 21 insertions(+) | ||
3007 | 11 | |||
3008 | 12 | diff --git a/src/util.c b/src/util.c | ||
3009 | 13 | index d4fcc26..b9b621c 100644 | ||
3010 | 14 | --- a/src/util.c | ||
3011 | 15 | +++ b/src/util.c | ||
3012 | 16 | @@ -895,6 +895,8 @@ _netplan_netdef_pertype_iter_next(struct netdef_pertype_iter* it) | ||
3013 | 17 | |||
3014 | 18 | while (g_hash_table_iter_next(&it->iter, &key, &value)) { | ||
3015 | 19 | NetplanNetDefinition* netdef = value; | ||
3016 | 20 | + if (netdef->type == NETPLAN_DEF_TYPE_NM_PLACEHOLDER_) | ||
3017 | 21 | + continue; | ||
3018 | 22 | if (it->type == NETPLAN_DEF_TYPE_NONE || netdef->type == it->type) | ||
3019 | 23 | return netdef; | ||
3020 | 24 | } | ||
3021 | 25 | diff --git a/tests/test_libnetplan.py b/tests/test_libnetplan.py | ||
3022 | 26 | index 84944a8..134cfa0 100644 | ||
3023 | 27 | --- a/tests/test_libnetplan.py | ||
3024 | 28 | +++ b/tests/test_libnetplan.py | ||
3025 | 29 | @@ -189,6 +189,25 @@ class TestNetdefIterator(TestBase): | ||
3026 | 30 | dhcp4: false''') | ||
3027 | 31 | self.assertSetEqual(set(["eth0", "br0"]), set(d.id for d in netplan.netdef.NetDefinitionIterator(state, None))) | ||
3028 | 32 | |||
3029 | 33 | + def test_iter_all_types_with_placeholder(self): | ||
3030 | 34 | + state = state_from_yaml(self.confdir, '''network: | ||
3031 | 35 | + renderer: NetworkManager | ||
3032 | 36 | + ethernets: | ||
3033 | 37 | + eth0: | ||
3034 | 38 | + dhcp4: false | ||
3035 | 39 | + virtual-ethernets: | ||
3036 | 40 | + # Netplan will create a placeholder netdef for veth321 | ||
3037 | 41 | + veth123: | ||
3038 | 42 | + peer: veth321 | ||
3039 | 43 | + bridges: | ||
3040 | 44 | + br0: | ||
3041 | 45 | + dhcp4: false''') | ||
3042 | 46 | + | ||
3043 | 47 | + # We call the property "type" here so it will try to translate the netdef type to a string | ||
3044 | 48 | + # and crash if it's a placeholder | ||
3045 | 49 | + expected = {"ethernets", "virtual-ethernets", "bridges"} | ||
3046 | 50 | + self.assertSetEqual(expected, set(d.type for d in netplan.netdef.NetDefinitionIterator(state, None))) | ||
3047 | 51 | + | ||
3048 | 52 | def test_iter_ethernets(self): | ||
3049 | 53 | state = state_from_yaml(self.confdir, '''network: | ||
3050 | 54 | ethernets: | ||
3051 | diff --git a/debian/patches/0007-tests-assert-generated-.service-files-in-assert_srio.patch b/debian/patches/0007-tests-assert-generated-.service-files-in-assert_srio.patch | |||
3052 | 55 | new file mode 100644 | 0 | new file mode 100644 |
3053 | index 0000000..b9c0dc7 | |||
3054 | --- /dev/null | |||
3055 | +++ b/debian/patches/0007-tests-assert-generated-.service-files-in-assert_srio.patch | |||
3056 | @@ -0,0 +1,26 @@ | |||
3057 | 1 | From: Danilo Egea Gondolfo <danilogondolfo@gmail.com> | ||
3058 | 2 | Date: Tue, 23 Jan 2024 13:39:45 +0000 | ||
3059 | 3 | Subject: tests: assert generated .service files in assert_sriov | ||
3060 | 4 | |||
3061 | 5 | We are not checking if the systemd units generated are correct. | ||
3062 | 6 | |||
3063 | 7 | Origin: https://github.com/canonical/netplan/pull/437 | ||
3064 | 8 | --- | ||
3065 | 9 | tests/generator/base.py | 7 +++++++ | ||
3066 | 10 | 1 file changed, 7 insertions(+) | ||
3067 | 11 | |||
3068 | 12 | diff --git a/tests/generator/base.py b/tests/generator/base.py | ||
3069 | 13 | index b7bf4f9..7795d40 100644 | ||
3070 | 14 | --- a/tests/generator/base.py | ||
3071 | 15 | +++ b/tests/generator/base.py | ||
3072 | 16 | @@ -491,3 +491,10 @@ class TestBase(unittest.TestCase): | ||
3073 | 17 | self.assertEqual(set(os.path.basename(file) for file in sriov_systemd_dir), | ||
3074 | 18 | {'netplan-sriov-' + f for f in file_contents_map}) | ||
3075 | 19 | self.assertEqual(set(os.listdir(self.workdir.name)) - {'lib'}, {'etc', 'run'}) | ||
3076 | 20 | + | ||
3077 | 21 | + for file in sriov_systemd_dir: | ||
3078 | 22 | + basename = os.path.basename(file) | ||
3079 | 23 | + with open(file, 'r') as f: | ||
3080 | 24 | + contents = f.read() | ||
3081 | 25 | + map_contents = file_contents_map.get(basename.replace('netplan-sriov-', '')) | ||
3082 | 26 | + self.assertEqual(map_contents, contents) | ||
3083 | diff --git a/debian/patches/0008-tests-sriov-test-if-the-generated-netplan-rebind-ser.patch b/debian/patches/0008-tests-sriov-test-if-the-generated-netplan-rebind-ser.patch | |||
3084 | 0 | new file mode 100644 | 27 | new file mode 100644 |
3085 | index 0000000..6aab075 | |||
3086 | --- /dev/null | |||
3087 | +++ b/debian/patches/0008-tests-sriov-test-if-the-generated-netplan-rebind-ser.patch | |||
3088 | @@ -0,0 +1,57 @@ | |||
3089 | 1 | From: Danilo Egea Gondolfo <danilogondolfo@gmail.com> | ||
3090 | 2 | Date: Tue, 23 Jan 2024 13:41:27 +0000 | ||
3091 | 3 | Subject: tests/sriov: test if the generated netplan-rebind service is correct | ||
3092 | 4 | |||
3093 | 5 | This test is currently failing due to interface duplicates being added | ||
3094 | 6 | to the list. | ||
3095 | 7 | |||
3096 | 8 | Origin: https://github.com/canonical/netplan/pull/437 | ||
3097 | 9 | --- | ||
3098 | 10 | tests/test_sriov.py | 36 ++++++++++++++++++++++++++++++++++++ | ||
3099 | 11 | 1 file changed, 36 insertions(+) | ||
3100 | 12 | |||
3101 | 13 | --- a/tests/test_sriov.py | ||
3102 | 14 | +++ b/tests/test_sriov.py | ||
3103 | 15 | @@ -879,6 +879,42 @@ | ||
3104 | 16 | ExecStart=/usr/sbin/netplan rebind enblue engreen | ||
3105 | 17 | '''}) | ||
3106 | 18 | |||
3107 | 19 | + def test_rebind_service_generation(self): | ||
3108 | 20 | + self.generate('''network: | ||
3109 | 21 | + version: 2 | ||
3110 | 22 | + ethernets: | ||
3111 | 23 | + engreen: | ||
3112 | 24 | + embedded-switch-mode: switchdev | ||
3113 | 25 | + delay-virtual-functions-rebind: true | ||
3114 | 26 | + enblue: | ||
3115 | 27 | + match: {driver: fake_driver} | ||
3116 | 28 | + set-name: enblue | ||
3117 | 29 | + embedded-switch-mode: legacy | ||
3118 | 30 | + delay-virtual-functions-rebind: true | ||
3119 | 31 | + virtual-function-count: 4 | ||
3120 | 32 | + sriov_blue_vf0: | ||
3121 | 33 | + link: enblue | ||
3122 | 34 | + sriov_blue_vf1: | ||
3123 | 35 | + link: enblue | ||
3124 | 36 | + sriov_blue_vf1: | ||
3125 | 37 | + link: enblue | ||
3126 | 38 | + sriov_green_vf0: | ||
3127 | 39 | + link: engreen | ||
3128 | 40 | + sriov_green_vf1: | ||
3129 | 41 | + link: engreen | ||
3130 | 42 | + sriov_green_vf2: | ||
3131 | 43 | + link: engreen''') | ||
3132 | 44 | + self.assert_sriov({'rebind.service': '''[Unit] | ||
3133 | 45 | +Description=(Re-)bind SR-IOV Virtual Functions to their driver | ||
3134 | 46 | +After=network.target | ||
3135 | 47 | +After=sys-subsystem-net-devices-enblue.device | ||
3136 | 48 | +After=sys-subsystem-net-devices-engreen.device | ||
3137 | 49 | + | ||
3138 | 50 | +[Service] | ||
3139 | 51 | +Type=oneshot | ||
3140 | 52 | +ExecStart=/usr/sbin/netplan rebind enblue engreen | ||
3141 | 53 | +'''}) | ||
3142 | 54 | + | ||
3143 | 55 | def test_rebind_not_delayed(self): | ||
3144 | 56 | self.generate('''network: | ||
3145 | 57 | version: 2 | ||
3146 | diff --git a/debian/patches/0009-sriov-don-t-generate-duplicate-entries-in-the-rebind.patch b/debian/patches/0009-sriov-don-t-generate-duplicate-entries-in-the-rebind.patch | |||
3147 | 0 | new file mode 100644 | 58 | new file mode 100644 |
3148 | index 0000000..3f596b6 | |||
3149 | --- /dev/null | |||
3150 | +++ b/debian/patches/0009-sriov-don-t-generate-duplicate-entries-in-the-rebind.patch | |||
3151 | @@ -0,0 +1,96 @@ | |||
3152 | 1 | From: Danilo Egea Gondolfo <danilogondolfo@gmail.com> | ||
3153 | 2 | Date: Tue, 23 Jan 2024 14:13:13 +0000 | ||
3154 | 3 | Subject: sriov: don't generate duplicate entries in the rebind.service file | ||
3155 | 4 | |||
3156 | 5 | When multiple VFs are present in the configuration, we end up generating | ||
3157 | 6 | many duplicates in the netplan-sriov-rebind.service file. | ||
3158 | 7 | |||
3159 | 8 | Use a hash set to store the PFs and automatically deduplicate entries. | ||
3160 | 9 | |||
3161 | 10 | Origin: https://github.com/canonical/netplan/pull/437 | ||
3162 | 11 | --- | ||
3163 | 12 | src/sriov.c | 35 ++++++++++++++++++++--------------- | ||
3164 | 13 | 1 file changed, 20 insertions(+), 15 deletions(-) | ||
3165 | 14 | |||
3166 | 15 | diff --git a/src/sriov.c b/src/sriov.c | ||
3167 | 16 | index 7d4944b..f8117f7 100644 | ||
3168 | 17 | --- a/src/sriov.c | ||
3169 | 18 | +++ b/src/sriov.c | ||
3170 | 19 | @@ -27,28 +27,34 @@ | ||
3171 | 20 | #include "sriov.h" | ||
3172 | 21 | |||
3173 | 22 | static gboolean | ||
3174 | 23 | -write_sriov_rebind_systemd_unit(const GString* pfs, const char* rootdir, GError** error) | ||
3175 | 24 | +write_sriov_rebind_systemd_unit(GHashTable* pfs, const char* rootdir, GError** error) | ||
3176 | 25 | { | ||
3177 | 26 | g_autofree gchar* id_escaped = NULL; | ||
3178 | 27 | g_autofree char* link = g_strjoin(NULL, rootdir ?: "", "/run/systemd/system/multi-user.target.wants/netplan-sriov-rebind.service", NULL); | ||
3179 | 28 | g_autofree char* path = g_strjoin(NULL, "/run/systemd/system/netplan-sriov-rebind.service", NULL); | ||
3180 | 29 | - gchar** split = NULL; | ||
3181 | 30 | + | ||
3182 | 31 | + GHashTableIter iter; | ||
3183 | 32 | + gpointer key; | ||
3184 | 33 | + GString* interfaces = g_string_new(""); | ||
3185 | 34 | |||
3186 | 35 | GString* s = g_string_new("[Unit]\n"); | ||
3187 | 36 | g_string_append(s, "Description=(Re-)bind SR-IOV Virtual Functions to their driver\n"); | ||
3188 | 37 | g_string_append_printf(s, "After=network.target\n"); | ||
3189 | 38 | |||
3190 | 39 | /* Run after udev */ | ||
3191 | 40 | - split = g_strsplit(pfs->str, " ", 0); | ||
3192 | 41 | - for (unsigned i = 0; split[i]; ++i) | ||
3193 | 42 | - g_string_append_printf(s, "After=sys-subsystem-net-devices-%s.device\n", | ||
3194 | 43 | - split[i]); | ||
3195 | 44 | - g_strfreev(split); | ||
3196 | 45 | + g_hash_table_iter_init(&iter, pfs); | ||
3197 | 46 | + while (g_hash_table_iter_next (&iter, &key, NULL)) { | ||
3198 | 47 | + const gchar* id = key; | ||
3199 | 48 | + g_string_append_printf(s, "After=sys-subsystem-net-devices-%s.device\n", id); | ||
3200 | 49 | + g_string_append_printf(interfaces, "%s ", id); | ||
3201 | 50 | + } | ||
3202 | 51 | |||
3203 | 52 | g_string_append(s, "\n[Service]\nType=oneshot\n"); | ||
3204 | 53 | - g_string_append_printf(s, "ExecStart=" SBINDIR "/netplan rebind %s\n", pfs->str); | ||
3205 | 54 | + g_string_truncate(interfaces, interfaces->len-1); /* cut trailing whitespace */ | ||
3206 | 55 | + g_string_append_printf(s, "ExecStart=" SBINDIR "/netplan rebind %s\n", interfaces->str); | ||
3207 | 56 | |||
3208 | 57 | g_string_free_to_file(s, rootdir, path, NULL); | ||
3209 | 58 | + g_string_free(interfaces, TRUE); | ||
3210 | 59 | |||
3211 | 60 | safe_mkdir_p_dir(link); | ||
3212 | 61 | if (symlink(path, link) < 0 && errno != EEXIST) { | ||
3213 | 62 | @@ -73,7 +79,7 @@ netplan_state_finish_sriov_write(const NetplanState* np_state, const char* rootd | ||
3214 | 63 | gboolean ret = TRUE; | ||
3215 | 64 | |||
3216 | 65 | if (np_state) { | ||
3217 | 66 | - GString* pfs = g_string_new(NULL); | ||
3218 | 67 | + GHashTable* rebind_pfs = g_hash_table_new(g_str_hash, g_str_equal); | ||
3219 | 68 | /* Find netdev interface names for SR-IOV PFs*/ | ||
3220 | 69 | for (GList* iterator = np_state->netdefs_ordered; iterator; iterator = iterator->next) { | ||
3221 | 70 | def = (NetplanNetDefinition*) iterator->data; | ||
3222 | 71 | @@ -88,20 +94,19 @@ netplan_state_finish_sriov_write(const NetplanState* np_state, const char* rootd | ||
3223 | 72 | |||
3224 | 73 | if (pf && pf->sriov_delay_virtual_functions_rebind) { | ||
3225 | 74 | if (pf->set_name) | ||
3226 | 75 | - g_string_append_printf(pfs, "%s ", pf->set_name); | ||
3227 | 76 | + g_hash_table_add(rebind_pfs, pf->set_name); | ||
3228 | 77 | else if (!pf->has_match) /* netdef_id == interface name */ | ||
3229 | 78 | - g_string_append_printf(pfs, "%s ", pf->id); | ||
3230 | 79 | + g_hash_table_add(rebind_pfs, pf->id); | ||
3231 | 80 | else | ||
3232 | 81 | g_warning("%s: Cannot rebind SR-IOV virtual functions, unknown interface name. " | ||
3233 | 82 | "Use 'netplan rebind <IFACE>' to rebind manually or use the 'set-name' stanza.", | ||
3234 | 83 | pf->id); | ||
3235 | 84 | } | ||
3236 | 85 | } | ||
3237 | 86 | - if (pfs->len > 0) { | ||
3238 | 87 | - g_string_truncate(pfs, pfs->len-1); /* cut trailing whitespace */ | ||
3239 | 88 | - ret = write_sriov_rebind_systemd_unit(pfs, rootdir, NULL); | ||
3240 | 89 | + if (g_hash_table_size(rebind_pfs) > 0) { | ||
3241 | 90 | + ret = write_sriov_rebind_systemd_unit(rebind_pfs, rootdir, NULL); | ||
3242 | 91 | } | ||
3243 | 92 | - g_string_free(pfs, TRUE); | ||
3244 | 93 | + g_hash_table_destroy(rebind_pfs); | ||
3245 | 94 | } | ||
3246 | 95 | |||
3247 | 96 | if (any_sriov) { | ||
3248 | diff --git a/debian/patches/lp1809994/0010-parse-improve-the-parsing-of-access-points-LP-180999.patch b/debian/patches/lp1809994/0010-parse-improve-the-parsing-of-access-points-LP-180999.patch | |||
3249 | 0 | deleted file mode 100644 | 97 | deleted file mode 100644 |
3250 | index 85392c7..0000000 | |||
3251 | --- a/debian/patches/lp1809994/0010-parse-improve-the-parsing-of-access-points-LP-180999.patch | |||
3252 | +++ /dev/null | |||
3253 | @@ -1,197 +0,0 @@ | |||
3254 | 1 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
3255 | 2 | Date: Fri, 6 Oct 2023 11:42:36 +0100 | ||
3256 | 3 | Subject: parse: improve the parsing of access-points (LP: #1809994) | ||
3257 | 4 | |||
3258 | 5 | When the parser requires a second pass, it will report access-points it | ||
3259 | 6 | already parsed as duplicates and error out. | ||
3260 | 7 | |||
3261 | 8 | With this change, access-points will be stored in a local hash table, | ||
3262 | 9 | which will be used to find duplicates in the same netdef, and moved to | ||
3263 | 10 | the netdef->access_points hash table in the end. Access-points already | ||
3264 | 11 | present in the netdef hash table will be considered already parsed and | ||
3265 | 12 | skipped. | ||
3266 | 13 | |||
3267 | 14 | Add a test to check the problem is fixed and another one to test if | ||
3268 | 15 | merging the access-points when the same interface is present in multiple | ||
3269 | 16 | files is working properly. | ||
3270 | 17 | |||
3271 | 18 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/1809994 | ||
3272 | 19 | Origin: https://github.com/canonical/netplan/pull/413 | ||
3273 | 20 | --- | ||
3274 | 21 | src/parse.c | 45 +++++++++++++++++++--------- | ||
3275 | 22 | src/types-internal.h | 3 ++ | ||
3276 | 23 | src/types.c | 2 +- | ||
3277 | 24 | tests/generator/test_common.py | 54 ++++++++++++++++++++++++++++++++++ | ||
3278 | 25 | 4 files changed, 89 insertions(+), 15 deletions(-) | ||
3279 | 26 | |||
3280 | 27 | --- a/src/parse.c | ||
3281 | 28 | +++ b/src/parse.c | ||
3282 | 29 | @@ -59,6 +59,9 @@ | ||
3283 | 30 | |||
3284 | 31 | NetplanParser global_parser = {0}; | ||
3285 | 32 | |||
3286 | 33 | +static gboolean | ||
3287 | 34 | +insert_kv_into_hash(void *key, void *value, void *hash); | ||
3288 | 35 | + | ||
3289 | 36 | /** | ||
3290 | 37 | * Load YAML file into a yaml_document_t. | ||
3291 | 38 | * | ||
3292 | 39 | @@ -1404,11 +1407,13 @@ | ||
3293 | 40 | static gboolean | ||
3294 | 41 | handle_wifi_access_points(NetplanParser* npp, yaml_node_t* node, const char* key_prefix, __unused const void* data, GError** error) | ||
3295 | 42 | { | ||
3296 | 43 | + GHashTable* access_points = g_hash_table_new(g_str_hash, g_str_equal); | ||
3297 | 44 | + | ||
3298 | 45 | for (yaml_node_pair_t* entry = node->data.mapping.pairs.start; entry < node->data.mapping.pairs.top; entry++) { | ||
3299 | 46 | NetplanWifiAccessPoint *access_point = NULL; | ||
3300 | 47 | g_autofree char* full_key = NULL; | ||
3301 | 48 | yaml_node_t* key, *value; | ||
3302 | 49 | - gboolean ret = TRUE; | ||
3303 | 50 | + const gchar* ssid; | ||
3304 | 51 | |||
3305 | 52 | key = yaml_document_get_node(&npp->doc, entry->key); | ||
3306 | 53 | assert_type(npp, key, YAML_SCALAR_NODE); | ||
3307 | 54 | @@ -1421,31 +1426,43 @@ | ||
3308 | 55 | continue; | ||
3309 | 56 | } | ||
3310 | 57 | |||
3311 | 58 | + ssid = scalar(key); | ||
3312 | 59 | + | ||
3313 | 60 | + /* Skip access-points that already exist in the netdef */ | ||
3314 | 61 | + if (npp->current.netdef->access_points && g_hash_table_contains(npp->current.netdef->access_points, ssid)) | ||
3315 | 62 | + continue; | ||
3316 | 63 | + | ||
3317 | 64 | + /* Check if there's already an SSID with that name in the list of APs we are parsing */ | ||
3318 | 65 | + if (g_hash_table_contains(access_points, ssid)) { | ||
3319 | 66 | + g_hash_table_foreach(access_points, free_access_point, NULL); | ||
3320 | 67 | + g_hash_table_destroy(access_points); | ||
3321 | 68 | + return yaml_error(npp, key, error, "%s: Duplicate access point SSID '%s'", npp->current.netdef->id, ssid); | ||
3322 | 69 | + } | ||
3323 | 70 | + | ||
3324 | 71 | g_assert(access_point == NULL); | ||
3325 | 72 | access_point = g_new0(NetplanWifiAccessPoint, 1); | ||
3326 | 73 | - access_point->ssid = g_strdup(scalar(key)); | ||
3327 | 74 | + access_point->ssid = g_strdup(ssid); | ||
3328 | 75 | g_debug("%s: adding wifi AP '%s'", npp->current.netdef->id, access_point->ssid); | ||
3329 | 76 | |||
3330 | 77 | - /* Check if there's already an SSID with that name */ | ||
3331 | 78 | - // FIXME: This check fails on multi-pass parsing, e.g. when defined in | ||
3332 | 79 | - // the same YAML file with a set of virtual-ethernets peers. | ||
3333 | 80 | - if (npp->current.netdef->access_points && | ||
3334 | 81 | - g_hash_table_lookup(npp->current.netdef->access_points, access_point->ssid)) { | ||
3335 | 82 | - ret = yaml_error(npp, key, error, "%s: Duplicate access point SSID '%s'", npp->current.netdef->id, access_point->ssid); | ||
3336 | 83 | - } | ||
3337 | 84 | - | ||
3338 | 85 | npp->current.access_point = access_point; | ||
3339 | 86 | - if (!ret || !process_mapping(npp, value, full_key, wifi_access_point_handlers, NULL, error)) { | ||
3340 | 87 | + if (!process_mapping(npp, value, full_key, wifi_access_point_handlers, NULL, error)) { | ||
3341 | 88 | access_point_clear(&npp->current.access_point, npp->current.backend); | ||
3342 | 89 | + g_hash_table_foreach(access_points, free_access_point, NULL); | ||
3343 | 90 | + g_hash_table_destroy(access_points); | ||
3344 | 91 | return FALSE; | ||
3345 | 92 | } | ||
3346 | 93 | |||
3347 | 94 | + g_hash_table_insert(access_points, access_point->ssid, access_point); | ||
3348 | 95 | + npp->current.access_point = NULL; | ||
3349 | 96 | + } | ||
3350 | 97 | + | ||
3351 | 98 | + if (g_hash_table_size(access_points) > 0) { | ||
3352 | 99 | if (!npp->current.netdef->access_points) | ||
3353 | 100 | npp->current.netdef->access_points = g_hash_table_new(g_str_hash, g_str_equal); | ||
3354 | 101 | - g_hash_table_insert(npp->current.netdef->access_points, access_point->ssid, access_point); | ||
3355 | 102 | - npp->current.access_point = NULL; | ||
3356 | 103 | + g_hash_table_foreach_steal(access_points, insert_kv_into_hash, npp->current.netdef->access_points); | ||
3357 | 104 | + mark_data_as_dirty(npp, &npp->current.netdef->access_points); | ||
3358 | 105 | } | ||
3359 | 106 | - mark_data_as_dirty(npp, &npp->current.netdef->access_points); | ||
3360 | 107 | + g_hash_table_destroy(access_points); | ||
3361 | 108 | return TRUE; | ||
3362 | 109 | } | ||
3363 | 110 | |||
3364 | 111 | --- a/src/types-internal.h | ||
3365 | 112 | +++ b/src/types-internal.h | ||
3366 | 113 | @@ -313,3 +313,6 @@ | ||
3367 | 114 | |||
3368 | 115 | void | ||
3369 | 116 | free_address_options(void* ptr); | ||
3370 | 117 | + | ||
3371 | 118 | +void | ||
3372 | 119 | +free_access_point(void* key, void* value, void* data); | ||
3373 | 120 | --- a/src/types.c | ||
3374 | 121 | +++ b/src/types.c | ||
3375 | 122 | @@ -200,7 +200,7 @@ | ||
3376 | 123 | * @data: pointer to a NetplanBackend value representing the renderer context in which | ||
3377 | 124 | * to interpret the processed object, especially regarding the backend settings | ||
3378 | 125 | */ | ||
3379 | 126 | -static void | ||
3380 | 127 | +void | ||
3381 | 128 | free_access_point(__unused void* key, void* value, __unused void* data) | ||
3382 | 129 | { | ||
3383 | 130 | NetplanWifiAccessPoint* ap = value; | ||
3384 | 131 | --- a/tests/generator/test_common.py | ||
3385 | 132 | +++ b/tests/generator/test_common.py | ||
3386 | 133 | @@ -1557,6 +1557,28 @@ | ||
3387 | 134 | ''', | ||
3388 | 135 | 'eth0.network': ND_EMPTY % ('eth0', 'no') + 'Bond=aggi\n'}) | ||
3389 | 136 | |||
3390 | 137 | + def test_check_parser_second_pass_will_not_lead_to_duplicate_access_point(self): | ||
3391 | 138 | + ''' | ||
3392 | 139 | + When the parser needs more than one pass we shouldn't | ||
3393 | 140 | + try to load the same access-point again from wifi devices. | ||
3394 | 141 | + Testcase for LP: #1809994''' | ||
3395 | 142 | + | ||
3396 | 143 | + self.generate('''network: | ||
3397 | 144 | + bridges: | ||
3398 | 145 | + br0: | ||
3399 | 146 | + interfaces: | ||
3400 | 147 | + - eth0 | ||
3401 | 148 | + ethernets: | ||
3402 | 149 | + eth0: | ||
3403 | 150 | + dhcp4: false | ||
3404 | 151 | + wifis: | ||
3405 | 152 | + wlan0: | ||
3406 | 153 | + dhcp4: true | ||
3407 | 154 | + access-points: | ||
3408 | 155 | + "mywifi": | ||
3409 | 156 | + password: "aaaaaaaa" | ||
3410 | 157 | +''') | ||
3411 | 158 | + | ||
3412 | 159 | |||
3413 | 160 | class TestMerging(TestBase): | ||
3414 | 161 | '''multiple *.yaml merging''' | ||
3415 | 162 | @@ -1740,3 +1762,35 @@ | ||
3416 | 163 | ''', | ||
3417 | 164 | 'enyellow.network': ND_DHCP4 % 'enyellow', | ||
3418 | 165 | 'enblue.network': ND_DHCP4 % 'enblue'}) | ||
3419 | 166 | + | ||
3420 | 167 | + def test_wifi_access_points_merging(self): | ||
3421 | 168 | + self.generate('''network: | ||
3422 | 169 | + version: 2 | ||
3423 | 170 | + wifis: | ||
3424 | 171 | + wlan0: | ||
3425 | 172 | + dhcp4: true | ||
3426 | 173 | + access-points: | ||
3427 | 174 | + "mywifi": | ||
3428 | 175 | + password: "aaaaaaaa"''', | ||
3429 | 176 | + confs={'newwifi': '''network: | ||
3430 | 177 | + version: 2 | ||
3431 | 178 | + wifis: | ||
3432 | 179 | + wlan0: | ||
3433 | 180 | + dhcp4: true | ||
3434 | 181 | + access-points: | ||
3435 | 182 | + "mynewwifi": | ||
3436 | 183 | + password: "aaaaaaaa"'''}) | ||
3437 | 184 | + | ||
3438 | 185 | + self.assert_wpa_supplicant("wlan0", """ctrl_interface=/run/wpa_supplicant | ||
3439 | 186 | + | ||
3440 | 187 | +network={ | ||
3441 | 188 | + ssid="mynewwifi" | ||
3442 | 189 | + key_mgmt=WPA-PSK | ||
3443 | 190 | + psk="aaaaaaaa" | ||
3444 | 191 | +} | ||
3445 | 192 | +network={ | ||
3446 | 193 | + ssid="mywifi" | ||
3447 | 194 | + key_mgmt=WPA-PSK | ||
3448 | 195 | + psk="aaaaaaaa" | ||
3449 | 196 | +} | ||
3450 | 197 | +""") | ||
3451 | diff --git a/debian/patches/lp1809994/0011-wifi-replace-the-previously-defined-AP-with-the-new-.patch b/debian/patches/lp1809994/0011-wifi-replace-the-previously-defined-AP-with-the-new-.patch | |||
3452 | 198 | deleted file mode 100644 | 0 | deleted file mode 100644 |
3453 | index c03521e..0000000 | |||
3454 | --- a/debian/patches/lp1809994/0011-wifi-replace-the-previously-defined-AP-with-the-new-.patch | |||
3455 | +++ /dev/null | |||
3456 | @@ -1,79 +0,0 @@ | |||
3457 | 1 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
3458 | 2 | Date: Thu, 12 Oct 2023 18:07:31 +0100 | ||
3459 | 3 | Subject: wifi: replace the previously defined AP with the new one | ||
3460 | 4 | |||
3461 | 5 | If we find an AP with the same name in the same interface, we drop the | ||
3462 | 6 | first one and use the new one. This is done to maintain the documented | ||
3463 | 7 | behavior of respecting the order in which the files are parsed. We still | ||
3464 | 8 | need to implement support for merging AP settings. | ||
3465 | 9 | |||
3466 | 10 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/1809994 | ||
3467 | 11 | Origin: https://github.com/canonical/netplan/pull/413 | ||
3468 | 12 | --- | ||
3469 | 13 | src/parse.c | 17 +++++++++++++---- | ||
3470 | 14 | tests/generator/test_common.py | 30 ++++++++++++++++++++++++++++++ | ||
3471 | 15 | 2 files changed, 43 insertions(+), 4 deletions(-) | ||
3472 | 16 | |||
3473 | 17 | --- a/src/parse.c | ||
3474 | 18 | +++ b/src/parse.c | ||
3475 | 19 | @@ -1428,11 +1428,20 @@ | ||
3476 | 20 | |||
3477 | 21 | ssid = scalar(key); | ||
3478 | 22 | |||
3479 | 23 | - /* Skip access-points that already exist in the netdef */ | ||
3480 | 24 | - if (npp->current.netdef->access_points && g_hash_table_contains(npp->current.netdef->access_points, ssid)) | ||
3481 | 25 | - continue; | ||
3482 | 26 | + /* | ||
3483 | 27 | + * Delete the access-point if it already exists in the netdef and let the new | ||
3484 | 28 | + * one be added. It has the side effect of reprocessing APs if the parser requires a | ||
3485 | 29 | + * second pass. | ||
3486 | 30 | + * | ||
3487 | 31 | + * TODO: implement support for merging AP settings if they were previously defined | ||
3488 | 32 | + */ | ||
3489 | 33 | + if (npp->current.netdef->access_points && g_hash_table_contains(npp->current.netdef->access_points, ssid)) { | ||
3490 | 34 | + NetplanWifiAccessPoint *ap = g_hash_table_lookup(npp->current.netdef->access_points, ssid); | ||
3491 | 35 | + g_hash_table_remove(npp->current.netdef->access_points, ssid); | ||
3492 | 36 | + free_access_point(NULL, ap, NULL); | ||
3493 | 37 | + } | ||
3494 | 38 | |||
3495 | 39 | - /* Check if there's already an SSID with that name in the list of APs we are parsing */ | ||
3496 | 40 | + /* Check if the SSID was already defined in the same netdef in this YAML file we are parsing */ | ||
3497 | 41 | if (g_hash_table_contains(access_points, ssid)) { | ||
3498 | 42 | g_hash_table_foreach(access_points, free_access_point, NULL); | ||
3499 | 43 | g_hash_table_destroy(access_points); | ||
3500 | 44 | --- a/tests/generator/test_common.py | ||
3501 | 45 | +++ b/tests/generator/test_common.py | ||
3502 | 46 | @@ -1794,3 +1794,33 @@ | ||
3503 | 47 | psk="aaaaaaaa" | ||
3504 | 48 | } | ||
3505 | 49 | """) | ||
3506 | 50 | + | ||
3507 | 51 | + def test_wifi_access_points_overwriting(self): | ||
3508 | 52 | + ''' If we find an AP that is already defined we drop the first one. | ||
3509 | 53 | + XXX: this test must be removed once we implement support for AP merging | ||
3510 | 54 | + ''' | ||
3511 | 55 | + self.generate('''network: | ||
3512 | 56 | + version: 2 | ||
3513 | 57 | + wifis: | ||
3514 | 58 | + wlan0: | ||
3515 | 59 | + dhcp4: true | ||
3516 | 60 | + access-points: | ||
3517 | 61 | + "mywifi": | ||
3518 | 62 | + password: "aaaaaaaa"''', | ||
3519 | 63 | + confs={'newwifi': '''network: | ||
3520 | 64 | + version: 2 | ||
3521 | 65 | + wifis: | ||
3522 | 66 | + wlan0: | ||
3523 | 67 | + dhcp4: true | ||
3524 | 68 | + access-points: | ||
3525 | 69 | + "mywifi": | ||
3526 | 70 | + password: "bbbbbbbb"'''}) | ||
3527 | 71 | + | ||
3528 | 72 | + self.assert_wpa_supplicant("wlan0", """ctrl_interface=/run/wpa_supplicant | ||
3529 | 73 | + | ||
3530 | 74 | +network={ | ||
3531 | 75 | + ssid="mywifi" | ||
3532 | 76 | + key_mgmt=WPA-PSK | ||
3533 | 77 | + psk="bbbbbbbb" | ||
3534 | 78 | +} | ||
3535 | 79 | +""") | ||
3536 | diff --git a/debian/patches/lp2034067/0004-tunnels-validation-do-not-error-out-if-local-is-not-.patch b/debian/patches/lp2034067/0004-tunnels-validation-do-not-error-out-if-local-is-not-.patch | |||
3537 | 80 | deleted file mode 100644 | 0 | deleted file mode 100644 |
3538 | index e65fc4e..0000000 | |||
3539 | --- a/debian/patches/lp2034067/0004-tunnels-validation-do-not-error-out-if-local-is-not-.patch | |||
3540 | +++ /dev/null | |||
3541 | @@ -1,98 +0,0 @@ | |||
3542 | 1 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
3543 | 2 | Date: Fri, 1 Sep 2023 15:30:46 +0100 | ||
3544 | 3 | Subject: tunnels/validation: do not error out if "local" is not defined | ||
3545 | 4 | |||
3546 | 5 | The "local" IP property is not required by backends so we shouldn't | ||
3547 | 6 | error out if it's not defined. | ||
3548 | 7 | |||
3549 | 8 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2034067 | ||
3550 | 9 | Origin: https://github.com/canonical/netplan/pull/407 | ||
3551 | 10 | --- | ||
3552 | 11 | src/networkd.c | 3 ++- | ||
3553 | 12 | src/nm.c | 3 ++- | ||
3554 | 13 | src/validation.c | 6 ++---- | ||
3555 | 14 | tests/generator/test_tunnels.py | 12 ------------ | ||
3556 | 15 | 4 files changed, 6 insertions(+), 18 deletions(-) | ||
3557 | 16 | |||
3558 | 17 | diff --git a/src/networkd.c b/src/networkd.c | ||
3559 | 18 | index 602b472..325197d 100644 | ||
3560 | 19 | --- a/src/networkd.c | ||
3561 | 20 | +++ b/src/networkd.c | ||
3562 | 21 | @@ -141,7 +141,8 @@ write_tunnel_params(GString* s, const NetplanNetDefinition* def) | ||
3563 | 22 | g_string_printf(params, "Independent=true\n"); | ||
3564 | 23 | if (def->tunnel.mode == NETPLAN_TUNNEL_MODE_IPIP6 || def->tunnel.mode == NETPLAN_TUNNEL_MODE_IP6IP6) | ||
3565 | 24 | g_string_append_printf(params, "Mode=%s\n", netplan_tunnel_mode_name(def->tunnel.mode)); | ||
3566 | 25 | - g_string_append_printf(params, "Local=%s\n", def->tunnel.local_ip); | ||
3567 | 26 | + if (def->tunnel.local_ip) | ||
3568 | 27 | + g_string_append_printf(params, "Local=%s\n", def->tunnel.local_ip); | ||
3569 | 28 | g_string_append_printf(params, "Remote=%s\n", def->tunnel.remote_ip); | ||
3570 | 29 | if (def->tunnel_ttl) | ||
3571 | 30 | g_string_append_printf(params, "TTL=%u\n", def->tunnel_ttl); | ||
3572 | 31 | diff --git a/src/nm.c b/src/nm.c | ||
3573 | 32 | index a8ae1a6..c9279d4 100644 | ||
3574 | 33 | --- a/src/nm.c | ||
3575 | 34 | +++ b/src/nm.c | ||
3576 | 35 | @@ -393,7 +393,8 @@ static void | ||
3577 | 36 | write_tunnel_params(const NetplanNetDefinition* def, GKeyFile *kf) | ||
3578 | 37 | { | ||
3579 | 38 | g_key_file_set_integer(kf, "ip-tunnel", "mode", def->tunnel.mode); | ||
3580 | 39 | - g_key_file_set_string(kf, "ip-tunnel", "local", def->tunnel.local_ip); | ||
3581 | 40 | + if (def->tunnel.local_ip) | ||
3582 | 41 | + g_key_file_set_string(kf, "ip-tunnel", "local", def->tunnel.local_ip); | ||
3583 | 42 | g_key_file_set_string(kf, "ip-tunnel", "remote", def->tunnel.remote_ip); | ||
3584 | 43 | if (def->tunnel_ttl) | ||
3585 | 44 | g_key_file_set_uint64(kf, "ip-tunnel", "ttl", def->tunnel_ttl); | ||
3586 | 45 | diff --git a/src/validation.c b/src/validation.c | ||
3587 | 46 | index 76fe1bb..4e37213 100644 | ||
3588 | 47 | --- a/src/validation.c | ||
3589 | 48 | +++ b/src/validation.c | ||
3590 | 49 | @@ -241,8 +241,6 @@ validate_tunnel_grammar(const NetplanParser* npp, NetplanNetDefinition* nd, yaml | ||
3591 | 50 | |||
3592 | 51 | /* Validate local/remote IPs */ | ||
3593 | 52 | if (nd->tunnel.mode != NETPLAN_TUNNEL_MODE_VXLAN) { | ||
3594 | 53 | - if (!nd->tunnel.local_ip) | ||
3595 | 54 | - return yaml_error(npp, node, error, "%s: missing 'local' property for tunnel", nd->id); | ||
3596 | 55 | if (!nd->tunnel.remote_ip) | ||
3597 | 56 | return yaml_error(npp, node, error, "%s: missing 'remote' property for tunnel", nd->id); | ||
3598 | 57 | } | ||
3599 | 58 | @@ -255,7 +253,7 @@ validate_tunnel_grammar(const NetplanParser* npp, NetplanNetDefinition* nd, yaml | ||
3600 | 59 | case NETPLAN_TUNNEL_MODE_IP6GRE: | ||
3601 | 60 | case NETPLAN_TUNNEL_MODE_IP6GRETAP: | ||
3602 | 61 | case NETPLAN_TUNNEL_MODE_VTI6: | ||
3603 | 62 | - if (!is_ip6_address(nd->tunnel.local_ip)) | ||
3604 | 63 | + if (nd->tunnel.local_ip && !is_ip6_address(nd->tunnel.local_ip)) | ||
3605 | 64 | return yaml_error(npp, node, error, "%s: 'local' must be a valid IPv6 address for this tunnel type", nd->id); | ||
3606 | 65 | if (!is_ip6_address(nd->tunnel.remote_ip)) | ||
3607 | 66 | return yaml_error(npp, node, error, "%s: 'remote' must be a valid IPv6 address for this tunnel type", nd->id); | ||
3608 | 67 | @@ -268,7 +266,7 @@ validate_tunnel_grammar(const NetplanParser* npp, NetplanNetDefinition* nd, yaml | ||
3609 | 68 | break; | ||
3610 | 69 | |||
3611 | 70 | default: | ||
3612 | 71 | - if (!is_ip4_address(nd->tunnel.local_ip)) | ||
3613 | 72 | + if (nd->tunnel.local_ip && !is_ip4_address(nd->tunnel.local_ip)) | ||
3614 | 73 | return yaml_error(npp, node, error, "%s: 'local' must be a valid IPv4 address for this tunnel type", nd->id); | ||
3615 | 74 | if (!is_ip4_address(nd->tunnel.remote_ip)) | ||
3616 | 75 | return yaml_error(npp, node, error, "%s: 'remote' must be a valid IPv4 address for this tunnel type", nd->id); | ||
3617 | 76 | diff --git a/tests/generator/test_tunnels.py b/tests/generator/test_tunnels.py | ||
3618 | 77 | index eec7b00..7a76de7 100644 | ||
3619 | 78 | --- a/tests/generator/test_tunnels.py | ||
3620 | 79 | +++ b/tests/generator/test_tunnels.py | ||
3621 | 80 | @@ -1643,18 +1643,6 @@ class TestConfigErrors(TestBase): | ||
3622 | 81 | out = self.generate(config, expect_fail=True) | ||
3623 | 82 | self.assertIn("Error in network definition: address '10.10.10.10/21' should not include /prefixlength", out) | ||
3624 | 83 | |||
3625 | 84 | - def test_missing_local_ip(self): | ||
3626 | 85 | - """Fail if local IP is missing""" | ||
3627 | 86 | - config = '''network: | ||
3628 | 87 | - version: 2 | ||
3629 | 88 | - tunnels: | ||
3630 | 89 | - tun0: | ||
3631 | 90 | - mode: gre | ||
3632 | 91 | - remote: 20.20.20.20 | ||
3633 | 92 | -''' | ||
3634 | 93 | - out = self.generate(config, expect_fail=True) | ||
3635 | 94 | - self.assertIn("Error in network definition: tun0: missing 'local' property for tunnel", out) | ||
3636 | 95 | - | ||
3637 | 96 | def test_missing_remote_ip(self): | ||
3638 | 97 | """Fail if remote IP is missing""" | ||
3639 | 98 | config = '''network: | ||
3640 | diff --git a/debian/patches/lp2034067/0005-tests-add-some-integration-tests-without-the-local-a.patch b/debian/patches/lp2034067/0005-tests-add-some-integration-tests-without-the-local-a.patch | |||
3641 | 99 | deleted file mode 100644 | 0 | deleted file mode 100644 |
3642 | index c99bc4d..0000000 | |||
3643 | --- a/debian/patches/lp2034067/0005-tests-add-some-integration-tests-without-the-local-a.patch | |||
3644 | +++ /dev/null | |||
3645 | @@ -1,81 +0,0 @@ | |||
3646 | 1 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
3647 | 2 | Date: Fri, 1 Sep 2023 17:48:30 +0100 | ||
3648 | 3 | Subject: tests: add some integration tests without the local address | ||
3649 | 4 | |||
3650 | 5 | Copy a few tunnels common tests and remove the local address to ensure | ||
3651 | 6 | both backends will work fine. | ||
3652 | 7 | |||
3653 | 8 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2034067 | ||
3654 | 9 | Origin: https://github.com/canonical/netplan/pull/407 | ||
3655 | 10 | --- | ||
3656 | 11 | tests/integration/tunnels.py | 43 +++++++++++++++++++++++++++++++++++++++++++ | ||
3657 | 12 | 1 file changed, 43 insertions(+) | ||
3658 | 13 | |||
3659 | 14 | diff --git a/tests/integration/tunnels.py b/tests/integration/tunnels.py | ||
3660 | 15 | index a915554..bdacb55 100644 | ||
3661 | 16 | --- a/tests/integration/tunnels.py | ||
3662 | 17 | +++ b/tests/integration/tunnels.py | ||
3663 | 18 | @@ -45,6 +45,20 @@ class _CommonTests(): | ||
3664 | 19 | self.generate_and_settle(['sit-tun0']) | ||
3665 | 20 | self.assert_iface('sit-tun0', ['sit-tun0@NONE', 'link.* 192.168.5.1 peer 99.99.99.99']) | ||
3666 | 21 | |||
3667 | 22 | + def test_tunnel_sit_without_local_address(self): | ||
3668 | 23 | + self.addCleanup(subprocess.call, ['ip', 'link', 'delete', 'sit-tun0'], stderr=subprocess.DEVNULL) | ||
3669 | 24 | + with open(self.config, 'w') as f: | ||
3670 | 25 | + f.write('''network: | ||
3671 | 26 | + renderer: %(r)s | ||
3672 | 27 | + version: 2 | ||
3673 | 28 | + tunnels: | ||
3674 | 29 | + sit-tun0: | ||
3675 | 30 | + mode: sit | ||
3676 | 31 | + remote: 99.99.99.99 | ||
3677 | 32 | +''' % {'r': self.backend}) | ||
3678 | 33 | + self.generate_and_settle(['sit-tun0']) | ||
3679 | 34 | + self.assert_iface('sit-tun0', ['sit-tun0@NONE', 'link.* 0.0.0.0 peer 99.99.99.99']) | ||
3680 | 35 | + | ||
3681 | 36 | def test_tunnel_ipip(self): | ||
3682 | 37 | self.addCleanup(subprocess.call, ['ip', 'link', 'delete', 'tun0'], stderr=subprocess.DEVNULL) | ||
3683 | 38 | with open(self.config, 'w') as f: | ||
3684 | 39 | @@ -61,6 +75,21 @@ class _CommonTests(): | ||
3685 | 40 | self.generate_and_settle(['tun0']) | ||
3686 | 41 | self.assert_iface('tun0', ['tun0@NONE', 'link.* 192.168.5.1 peer 99.99.99.99']) | ||
3687 | 42 | |||
3688 | 43 | + def test_tunnel_ipip_without_local_address(self): | ||
3689 | 44 | + self.addCleanup(subprocess.call, ['ip', 'link', 'delete', 'tun0'], stderr=subprocess.DEVNULL) | ||
3690 | 45 | + with open(self.config, 'w') as f: | ||
3691 | 46 | + f.write('''network: | ||
3692 | 47 | + renderer: %(r)s | ||
3693 | 48 | + version: 2 | ||
3694 | 49 | + tunnels: | ||
3695 | 50 | + tun0: | ||
3696 | 51 | + mode: ipip | ||
3697 | 52 | + remote: 99.99.99.99 | ||
3698 | 53 | + ttl: 64 | ||
3699 | 54 | +''' % {'r': self.backend}) | ||
3700 | 55 | + self.generate_and_settle(['tun0']) | ||
3701 | 56 | + self.assert_iface('tun0', ['tun0@NONE', 'link.* 0.0.0.0 peer 99.99.99.99']) | ||
3702 | 57 | + | ||
3703 | 58 | def test_tunnel_wireguard(self): | ||
3704 | 59 | self.addCleanup(subprocess.call, ['ip', 'link', 'delete', 'wg0'], stderr=subprocess.DEVNULL) | ||
3705 | 60 | self.addCleanup(subprocess.call, ['ip', 'link', 'delete', 'wg1'], stderr=subprocess.DEVNULL) | ||
3706 | 61 | @@ -142,6 +171,20 @@ class _CommonTests(): | ||
3707 | 62 | self.generate_and_settle(['tun0']) | ||
3708 | 63 | self.assert_iface('tun0', ['tun0@NONE', 'link.* 192.168.5.1 peer 99.99.99.99']) | ||
3709 | 64 | |||
3710 | 65 | + def test_tunnel_gre_without_local_address(self): | ||
3711 | 66 | + self.addCleanup(subprocess.call, ['ip', 'link', 'delete', 'tun0'], stderr=subprocess.DEVNULL) | ||
3712 | 67 | + with open(self.config, 'w') as f: | ||
3713 | 68 | + f.write('''network: | ||
3714 | 69 | + renderer: %(r)s | ||
3715 | 70 | + version: 2 | ||
3716 | 71 | + tunnels: | ||
3717 | 72 | + tun0: | ||
3718 | 73 | + mode: gre | ||
3719 | 74 | + remote: 99.99.99.99 | ||
3720 | 75 | +''' % {'r': self.backend}) | ||
3721 | 76 | + self.generate_and_settle(['tun0']) | ||
3722 | 77 | + self.assert_iface('tun0', ['tun0@NONE', 'link.* 0.0.0.0 peer 99.99.99.99']) | ||
3723 | 78 | + | ||
3724 | 79 | def test_tunnel_gre6(self): | ||
3725 | 80 | self.addCleanup(subprocess.call, ['ip', 'link', 'delete', 'tun0'], stderr=subprocess.DEVNULL) | ||
3726 | 81 | with open(self.config, 'w') as f: | ||
3727 | diff --git a/debian/patches/lp2034595/0006-apply-bring-lo-back-up-if-it-s-managed-by-NM.patch b/debian/patches/lp2034595/0006-apply-bring-lo-back-up-if-it-s-managed-by-NM.patch | |||
3728 | 82 | deleted file mode 100644 | 0 | deleted file mode 100644 |
3729 | index 030036b..0000000 | |||
3730 | --- a/debian/patches/lp2034595/0006-apply-bring-lo-back-up-if-it-s-managed-by-NM.patch | |||
3731 | +++ /dev/null | |||
3732 | @@ -1,52 +0,0 @@ | |||
3733 | 1 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
3734 | 2 | Date: Tue, 5 Sep 2023 18:03:10 +0100 | ||
3735 | 3 | Subject: apply: bring "lo" back up if it's managed by NM | ||
3736 | 4 | |||
3737 | 5 | Origin: https://github.com/canonical/netplan/pull/408 | ||
3738 | 6 | Bug: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2034595 | ||
3739 | 7 | |||
3740 | 8 | NM is not bringing it back automatically after we flush its addresses. | ||
3741 | 9 | It's not clear if it's a bug or intended behavior. | ||
3742 | 10 | --- | ||
3743 | 11 | netplan_cli/cli/commands/apply.py | 16 +++++++++++++++- | ||
3744 | 12 | 1 file changed, 15 insertions(+), 1 deletion(-) | ||
3745 | 13 | |||
3746 | 14 | diff --git a/netplan_cli/cli/commands/apply.py b/netplan_cli/cli/commands/apply.py | ||
3747 | 15 | index 8bf8a94..181e400 100644 | ||
3748 | 16 | --- a/netplan_cli/cli/commands/apply.py | ||
3749 | 17 | +++ b/netplan_cli/cli/commands/apply.py | ||
3750 | 18 | @@ -286,12 +286,18 @@ class NetplanApply(utils.NetplanCommand): | ||
3751 | 19 | if restart_nm: | ||
3752 | 20 | # Flush all IP addresses of NM managed interfaces, to avoid NM creating | ||
3753 | 21 | # new, non netplan-* connection profiles, using the existing IPs. | ||
3754 | 22 | - for iface in utils.nm_interfaces(restart_nm_glob, devices): | ||
3755 | 23 | + nm_interfaces = utils.nm_interfaces(restart_nm_glob, devices) | ||
3756 | 24 | + for iface in nm_interfaces: | ||
3757 | 25 | utils.ip_addr_flush(iface) | ||
3758 | 26 | # clear NM state, especially the [device].managed=true config, as that might have been | ||
3759 | 27 | # re-set via an udev rule setting "NM_UNMANAGED=1" | ||
3760 | 28 | shutil.rmtree('/run/NetworkManager/devices', ignore_errors=True) | ||
3761 | 29 | utils.systemctl_network_manager('start', sync=sync) | ||
3762 | 30 | + # If 'lo' is in the nm_interfaces set we flushed it's IPs (see above) and will need to bring it | ||
3763 | 31 | + # back manually. For that, we need NM up and ready to accept commands | ||
3764 | 32 | + if 'lo' in nm_interfaces: | ||
3765 | 33 | + sync = True | ||
3766 | 34 | + | ||
3767 | 35 | if sync: | ||
3768 | 36 | # 'nmcli' could be /usr/bin/nmcli or | ||
3769 | 37 | # /snap/bin/nmcli -> /snap/bin/network-manager.nmcli | ||
3770 | 38 | @@ -309,6 +315,14 @@ class NetplanApply(utils.NetplanCommand): | ||
3771 | 39 | break | ||
3772 | 40 | time.sleep(0.5) | ||
3773 | 41 | |||
3774 | 42 | + # If "lo" is managed by NM through Netplan, apply will flush its addresses and NM | ||
3775 | 43 | + # will not bring it back automatically like other connections. | ||
3776 | 44 | + # This is a possible scenario with netplan-everywhere. If a user tries to change the 'lo' | ||
3777 | 45 | + # connection with nmcli for example, NM will create a persistent nmconnection file and emit a YAML for it. | ||
3778 | 46 | + if 'lo' in nm_interfaces: | ||
3779 | 47 | + cmd = ['nmcli', 'con', 'up', 'lo'] | ||
3780 | 48 | + subprocess.call(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) | ||
3781 | 49 | + | ||
3782 | 50 | @staticmethod | ||
3783 | 51 | def is_composite_member(composites, phy): | ||
3784 | 52 | """ | ||
3785 | diff --git a/debian/patches/lp2034595/0007-apply-don-t-assume-the-NM-loopback-connection-is-cal.patch b/debian/patches/lp2034595/0007-apply-don-t-assume-the-NM-loopback-connection-is-cal.patch | |||
3786 | 53 | deleted file mode 100644 | 0 | deleted file mode 100644 |
3787 | index ca364c9..0000000 | |||
3788 | --- a/debian/patches/lp2034595/0007-apply-don-t-assume-the-NM-loopback-connection-is-cal.patch | |||
3789 | +++ /dev/null | |||
3790 | @@ -1,108 +0,0 @@ | |||
3791 | 1 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
3792 | 2 | Date: Thu, 7 Sep 2023 14:10:54 +0100 | ||
3793 | 3 | Subject: apply: don't assume the NM loopback connection is called "lo" | ||
3794 | 4 | |||
3795 | 5 | Origin: https://github.com/canonical/netplan/pull/408 | ||
3796 | 6 | Bug: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2034595 | ||
3797 | 7 | |||
3798 | 8 | It might have any name, so we need to get the connection name | ||
3799 | 9 | dynamically. | ||
3800 | 10 | --- | ||
3801 | 11 | netplan_cli/cli/commands/apply.py | 18 +++++++++++------- | ||
3802 | 12 | netplan_cli/cli/utils.py | 14 ++++++++++++++ | ||
3803 | 13 | tests/test_utils.py | 12 ++++++++++++ | ||
3804 | 14 | 3 files changed, 37 insertions(+), 7 deletions(-) | ||
3805 | 15 | |||
3806 | 16 | diff --git a/netplan_cli/cli/commands/apply.py b/netplan_cli/cli/commands/apply.py | ||
3807 | 17 | index 181e400..066f496 100644 | ||
3808 | 18 | --- a/netplan_cli/cli/commands/apply.py | ||
3809 | 19 | +++ b/netplan_cli/cli/commands/apply.py | ||
3810 | 20 | @@ -176,9 +176,12 @@ class NetplanApply(utils.NetplanCommand): | ||
3811 | 21 | else: | ||
3812 | 22 | logging.debug('no netplan generated networkd configuration exists') | ||
3813 | 23 | |||
3814 | 24 | + loopback_connection = '' | ||
3815 | 25 | if restart_nm: | ||
3816 | 26 | logging.debug('netplan generated NM configuration changed, restarting NM') | ||
3817 | 27 | if utils.nm_running(): | ||
3818 | 28 | + if 'lo' in nm_ifaces: | ||
3819 | 29 | + loopback_connection = utils.nm_get_connection_for_interface('lo') | ||
3820 | 30 | # restarting NM does not cause new config to be applied, need to shut down devices first | ||
3821 | 31 | for device in devices: | ||
3822 | 32 | if device not in nm_ifaces: | ||
3823 | 33 | @@ -293,8 +296,10 @@ class NetplanApply(utils.NetplanCommand): | ||
3824 | 34 | # re-set via an udev rule setting "NM_UNMANAGED=1" | ||
3825 | 35 | shutil.rmtree('/run/NetworkManager/devices', ignore_errors=True) | ||
3826 | 36 | utils.systemctl_network_manager('start', sync=sync) | ||
3827 | 37 | - # If 'lo' is in the nm_interfaces set we flushed it's IPs (see above) and will need to bring it | ||
3828 | 38 | - # back manually. For that, we need NM up and ready to accept commands | ||
3829 | 39 | + | ||
3830 | 40 | + # If 'lo' is in the nm_interfaces set we flushed it's IPs (see above) and disconnected it. | ||
3831 | 41 | + # NM will not bring it back automatically after restarting and we need to do that manually. | ||
3832 | 42 | + # For that, we need NM up and ready to accept commands | ||
3833 | 43 | if 'lo' in nm_interfaces: | ||
3834 | 44 | sync = True | ||
3835 | 45 | |||
3836 | 46 | @@ -315,13 +320,12 @@ class NetplanApply(utils.NetplanCommand): | ||
3837 | 47 | break | ||
3838 | 48 | time.sleep(0.5) | ||
3839 | 49 | |||
3840 | 50 | - # If "lo" is managed by NM through Netplan, apply will flush its addresses and NM | ||
3841 | 51 | - # will not bring it back automatically like other connections. | ||
3842 | 52 | + # If "lo" is managed by NM through Netplan, apply will flush its addresses and disconnect it. | ||
3843 | 53 | + # NM will not bring it back automatically. | ||
3844 | 54 | # This is a possible scenario with netplan-everywhere. If a user tries to change the 'lo' | ||
3845 | 55 | # connection with nmcli for example, NM will create a persistent nmconnection file and emit a YAML for it. | ||
3846 | 56 | - if 'lo' in nm_interfaces: | ||
3847 | 57 | - cmd = ['nmcli', 'con', 'up', 'lo'] | ||
3848 | 58 | - subprocess.call(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) | ||
3849 | 59 | + if 'lo' in nm_interfaces and loopback_connection: | ||
3850 | 60 | + utils.nm_bring_interface_up(loopback_connection) | ||
3851 | 61 | |||
3852 | 62 | @staticmethod | ||
3853 | 63 | def is_composite_member(composites, phy): | ||
3854 | 64 | diff --git a/netplan_cli/cli/utils.py b/netplan_cli/cli/utils.py | ||
3855 | 65 | index d0a85df..a5f60c9 100644 | ||
3856 | 66 | --- a/netplan_cli/cli/utils.py | ||
3857 | 67 | +++ b/netplan_cli/cli/utils.py | ||
3858 | 68 | @@ -78,6 +78,20 @@ def nm_interfaces(paths, devices): | ||
3859 | 69 | return interfaces | ||
3860 | 70 | |||
3861 | 71 | |||
3862 | 72 | +def nm_get_connection_for_interface(interface: str) -> str: | ||
3863 | 73 | + output = nmcli_out(['-m', 'tabular', '-f', 'GENERAL.CONNECTION', 'device', 'show', interface]) | ||
3864 | 74 | + lines = output.strip().split('\n') | ||
3865 | 75 | + connection = lines[1] | ||
3866 | 76 | + return connection if connection != '--' else '' | ||
3867 | 77 | + | ||
3868 | 78 | + | ||
3869 | 79 | +def nm_bring_interface_up(connection: str) -> None: # pragma: nocover (must be covered by NM autopkgtests) | ||
3870 | 80 | + try: | ||
3871 | 81 | + nmcli(['connection', 'up', connection]) | ||
3872 | 82 | + except subprocess.CalledProcessError: | ||
3873 | 83 | + pass | ||
3874 | 84 | + | ||
3875 | 85 | + | ||
3876 | 86 | def systemctl_network_manager(action, sync=False): | ||
3877 | 87 | # If the network-manager snap is installed use its service | ||
3878 | 88 | # name rather than the one of the deb packaged NetworkManager | ||
3879 | 89 | diff --git a/tests/test_utils.py b/tests/test_utils.py | ||
3880 | 90 | index ec57087..b2a1657 100644 | ||
3881 | 91 | --- a/tests/test_utils.py | ||
3882 | 92 | +++ b/tests/test_utils.py | ||
3883 | 93 | @@ -371,3 +371,15 @@ class TestUtils(unittest.TestCase): | ||
3884 | 94 | self.assertEqual(self.mock_cmd.calls(), [ | ||
3885 | 95 | ['ip', 'addr', 'flush', 'eth42'] | ||
3886 | 96 | ]) | ||
3887 | 97 | + | ||
3888 | 98 | + @patch('netplan_cli.cli.utils.nmcli_out') | ||
3889 | 99 | + def test_nm_get_connection_for_interface(self, nmcli): | ||
3890 | 100 | + nmcli.return_value = 'CONNECTION \nlo \n' | ||
3891 | 101 | + out = utils.nm_get_connection_for_interface('lo') | ||
3892 | 102 | + self.assertEqual(out, 'lo') | ||
3893 | 103 | + | ||
3894 | 104 | + @patch('netplan_cli.cli.utils.nmcli_out') | ||
3895 | 105 | + def test_nm_get_connection_for_interface_no_connection(self, nmcli): | ||
3896 | 106 | + nmcli.return_value = 'CONNECTION \n-- \n' | ||
3897 | 107 | + out = utils.nm_get_connection_for_interface('asd0') | ||
3898 | 108 | + self.assertEqual(out, '') | ||
3899 | diff --git a/debian/patches/lp2039821/0008-wireguard-ignore-empty-endpoints.patch b/debian/patches/lp2039821/0008-wireguard-ignore-empty-endpoints.patch | |||
3900 | 109 | deleted file mode 100644 | 0 | deleted file mode 100644 |
3901 | index e2b3892..0000000 | |||
3902 | --- a/debian/patches/lp2039821/0008-wireguard-ignore-empty-endpoints.patch | |||
3903 | +++ /dev/null | |||
3904 | @@ -1,117 +0,0 @@ | |||
3905 | 1 | From 1758948e6cb064b9b00ba3b42ce36ea9546d4773 Mon Sep 17 00:00:00 2001 | ||
3906 | 2 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
3907 | 3 | Date: Tue, 10 Oct 2023 11:06:51 +0100 | ||
3908 | 4 | Subject: wireguard: ignore empty endpoints | ||
3909 | 5 | |||
3910 | 6 | The Network Manager GUI will emit 'Endpoint=' if it's not specified when | ||
3911 | 7 | creating the tunnel. libnetplan is generating 'endpoint: ""' in this case | ||
3912 | 8 | and the parser is returning an error. | ||
3913 | 9 | |||
3914 | 10 | In nm-parse, if Endpoint is either empty or NULL we'll just not read it. In | ||
3915 | 11 | the parser, if we find 'endpoint: ""', we'll just ignore it as if it | ||
3916 | 12 | were not defined. | ||
3917 | 13 | |||
3918 | 14 | See LP: #2038811 | ||
3919 | 15 | |||
3920 | 16 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2039821 | ||
3921 | 17 | Origin: https://github.com/canonical/netplan/pull/414 | ||
3922 | 18 | --- | ||
3923 | 19 | src/parse-nm.c | 6 +++++- | ||
3924 | 20 | src/parse.c | 5 +++++ | ||
3925 | 21 | tests/generator/test_tunnels.py | 9 ++++++++ | ||
3926 | 22 | tests/parser/test_keyfile.py | 37 +++++++++++++++++++++++++++++++++ | ||
3927 | 23 | 4 files changed, 56 insertions(+), 1 deletion(-) | ||
3928 | 24 | |||
3929 | 25 | --- a/src/parse-nm.c | ||
3930 | 26 | +++ b/src/parse-nm.c | ||
3931 | 27 | @@ -552,7 +552,11 @@ | ||
3932 | 28 | } | ||
3933 | 29 | |||
3934 | 30 | /* Handle endpoint */ | ||
3935 | 31 | - wireguard_peer->endpoint = g_key_file_get_string(kf, group, "endpoint", NULL); | ||
3936 | 32 | + gchar* endpoint = g_key_file_get_string(kf, group, "endpoint", NULL); | ||
3937 | 33 | + if (endpoint && g_strcmp0(endpoint, "")) { | ||
3938 | 34 | + /* Only set the endpoint if it's not NULL nor an empty string */ | ||
3939 | 35 | + wireguard_peer->endpoint = endpoint; | ||
3940 | 36 | + } | ||
3941 | 37 | _kf_clear_key(kf, group, "endpoint"); | ||
3942 | 38 | |||
3943 | 39 | g_array_append_val(nd->wireguard_peers, wireguard_peer); | ||
3944 | 40 | --- a/src/parse.c | ||
3945 | 41 | +++ b/src/parse.c | ||
3946 | 42 | @@ -2445,6 +2445,11 @@ | ||
3947 | 43 | char* address; | ||
3948 | 44 | guint64 port_num; | ||
3949 | 45 | |||
3950 | 46 | + /* If endpoint is an empty string just ignore it */ | ||
3951 | 47 | + if (!g_strcmp0(scalar(node), "")) { | ||
3952 | 48 | + return TRUE; | ||
3953 | 49 | + } | ||
3954 | 50 | + | ||
3955 | 51 | endpoint = g_strdup(scalar(node)); | ||
3956 | 52 | /* absolute minimal length of endpoint is 3 chars: 'h:8' */ | ||
3957 | 53 | if (strlen(endpoint) < 3) { | ||
3958 | 54 | --- a/tests/generator/test_tunnels.py | ||
3959 | 55 | +++ b/tests/generator/test_tunnels.py | ||
3960 | 56 | @@ -309,6 +309,15 @@ | ||
3961 | 57 | out = self.generate(config, expect_fail=True) | ||
3962 | 58 | self.assertIn("Error in network definition: wg0: a public key is required.", out) | ||
3963 | 59 | |||
3964 | 60 | + def test_empty_string_as_endpoint_should_be_ignored(self): | ||
3965 | 61 | + """[wireguard] If the endpoint key is present but set to '' it should just be ignored""" | ||
3966 | 62 | + config = prepare_wg_config(listen=12345, privkey='KPt9BzQjejRerEv8RMaFlpsD675gNexELOQRXt/AcH0=', | ||
3967 | 63 | + peers=[{'public-key': 'rlbInAj0qV69CysWPQY7KEBnKxpYCpaWqOs/dLevdWc=', | ||
3968 | 64 | + 'allowed-ips': '[0.0.0.0/0, "2001:fe:ad:de:ad:be:ef:1/24"]', | ||
3969 | 65 | + 'keepalive': 14, | ||
3970 | 66 | + 'endpoint': '\"\"'}], renderer=self.backend) | ||
3971 | 67 | + self.generate(config, skip_generated_yaml_validation=True) | ||
3972 | 68 | + | ||
3973 | 69 | def test_vxlan_port_range_fail(self): | ||
3974 | 70 | out = self.generate('''network: | ||
3975 | 71 | tunnels: | ||
3976 | 72 | --- a/tests/parser/test_keyfile.py | ||
3977 | 73 | +++ b/tests/parser/test_keyfile.py | ||
3978 | 74 | @@ -1591,6 +1591,43 @@ | ||
3979 | 75 | connection.interface-name: "wg0" | ||
3980 | 76 | '''.format(UUID, UUID)}) | ||
3981 | 77 | |||
3982 | 78 | + def test_wireguard_with_empty_endpoint(self): | ||
3983 | 79 | + self.generate_from_keyfile('''[connection] | ||
3984 | 80 | +id=wg0 | ||
3985 | 81 | +type=wireguard | ||
3986 | 82 | +uuid={} | ||
3987 | 83 | +interface-name=wg0 | ||
3988 | 84 | + | ||
3989 | 85 | +[wireguard] | ||
3990 | 86 | +private-key=aPUcp5vHz8yMLrzk8SsDyYnV33IhE/k20e52iKJFV0A= | ||
3991 | 87 | + | ||
3992 | 88 | +[wireguard-peer.cwkb7k0xDgLSnunZpFIjLJw4u+mJDDr+aBR5DqzpmgI=] | ||
3993 | 89 | +endpoint= | ||
3994 | 90 | +allowed-ips=192.168.0.0/24; | ||
3995 | 91 | + | ||
3996 | 92 | +[ipv4] | ||
3997 | 93 | +method=auto\n'''.format(UUID), regenerate=False) | ||
3998 | 94 | + self.assert_netplan({UUID: '''network: | ||
3999 | 95 | + version: 2 | ||
4000 | 96 | + tunnels: | ||
4001 | 97 | + NM-{}: | ||
4002 | 98 | + renderer: NetworkManager | ||
4003 | 99 | + dhcp4: true | ||
4004 | 100 | + mode: "wireguard" | ||
4005 | 101 | + keys: | ||
4006 | 102 | + private: "aPUcp5vHz8yMLrzk8SsDyYnV33IhE/k20e52iKJFV0A=" | ||
4007 | 103 | + peers: | ||
4008 | 104 | + - keys: | ||
4009 | 105 | + public: "cwkb7k0xDgLSnunZpFIjLJw4u+mJDDr+aBR5DqzpmgI=" | ||
4010 | 106 | + allowed-ips: | ||
4011 | 107 | + - "192.168.0.0/24" | ||
4012 | 108 | + networkmanager: | ||
4013 | 109 | + uuid: "{}" | ||
4014 | 110 | + name: "wg0" | ||
4015 | 111 | + passthrough: | ||
4016 | 112 | + connection.interface-name: "wg0" | ||
4017 | 113 | +'''.format(UUID, UUID)}) | ||
4018 | 114 | + | ||
4019 | 115 | def test_wireguard_allowed_ips_without_prefix(self): | ||
4020 | 116 | ''' | ||
4021 | 117 | When the IP prefix is not present we should default to /32 | ||
4022 | diff --git a/debian/patches/lp2039825/0009-auth-add-support-for-LEAP-and-EAP-PWD.patch b/debian/patches/lp2039825/0009-auth-add-support-for-LEAP-and-EAP-PWD.patch | |||
4023 | 118 | deleted file mode 100644 | 0 | deleted file mode 100644 |
4024 | index d13d07e..0000000 | |||
4025 | --- a/debian/patches/lp2039825/0009-auth-add-support-for-LEAP-and-EAP-PWD.patch | |||
4026 | +++ /dev/null | |||
4027 | @@ -1,371 +0,0 @@ | |||
4028 | 1 | From 4a5a9ed735688c3c19cd86d6638ec4ff5bdf17e4 Mon Sep 17 00:00:00 2001 | ||
4029 | 2 | From: Danilo Egea Gondolfo <danilo.egea.gondolfo@canonical.com> | ||
4030 | 3 | Date: Tue, 10 Oct 2023 16:21:53 +0100 | ||
4031 | 4 | Subject: auth: add support for LEAP and EAP-PWD | ||
4032 | 5 | |||
4033 | 6 | This changes add support for the LEAP and PWD EAP authentication methods | ||
4034 | 7 | for NetworkManager, wpa_supplicant (networkd) and the keyfile parser. | ||
4035 | 8 | |||
4036 | 9 | Using these method through the NM GUI is causing problems because | ||
4037 | 10 | libnetplan will generate a broken keyfile. See LP: #2038811 | ||
4038 | 11 | |||
4039 | 12 | Note that the NM GUI supports more methods not recognized by netplan and | ||
4040 | 13 | we probably should also implement them later. | ||
4041 | 14 | |||
4042 | 15 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2039825 | ||
4043 | 16 | Origin: https://github.com/canonical/netplan/pull/415 | ||
4044 | 17 | --- | ||
4045 | 18 | doc/netplan-yaml.md | 3 +- | ||
4046 | 19 | src/abi.h | 2 + | ||
4047 | 20 | src/names.c | 2 + | ||
4048 | 21 | src/networkd.c | 8 +++ | ||
4049 | 22 | src/nm.c | 6 ++ | ||
4050 | 23 | src/parse-nm.c | 4 ++ | ||
4051 | 24 | src/parse.c | 4 ++ | ||
4052 | 25 | tests/generator/test_wifis.py | 124 ++++++++++++++++++++++++++++++++++ | ||
4053 | 26 | tests/parser/test_keyfile.py | 100 +++++++++++++++++++++++++++ | ||
4054 | 27 | 9 files changed, 252 insertions(+), 1 deletion(-) | ||
4055 | 28 | |||
4056 | 29 | --- a/src/abi.h | ||
4057 | 30 | +++ b/src/abi.h | ||
4058 | 31 | @@ -116,6 +116,8 @@ | ||
4059 | 32 | NETPLAN_AUTH_EAP_TLS, | ||
4060 | 33 | NETPLAN_AUTH_EAP_PEAP, | ||
4061 | 34 | NETPLAN_AUTH_EAP_TTLS, | ||
4062 | 35 | + NETPLAN_AUTH_EAP_LEAP, | ||
4063 | 36 | + NETPLAN_AUTH_EAP_PWD, | ||
4064 | 37 | NETPLAN_AUTH_EAP_METHOD_MAX, | ||
4065 | 38 | } NetplanAuthEAPMethod; | ||
4066 | 39 | |||
4067 | 40 | --- a/src/names.c | ||
4068 | 41 | +++ b/src/names.c | ||
4069 | 42 | @@ -70,6 +70,8 @@ | ||
4070 | 43 | [NETPLAN_AUTH_EAP_TLS] = "tls", | ||
4071 | 44 | [NETPLAN_AUTH_EAP_PEAP] = "peap", | ||
4072 | 45 | [NETPLAN_AUTH_EAP_TTLS] = "ttls", | ||
4073 | 46 | + [NETPLAN_AUTH_EAP_LEAP] = "leap", | ||
4074 | 47 | + [NETPLAN_AUTH_EAP_PWD] = "pwd", | ||
4075 | 48 | }; | ||
4076 | 49 | |||
4077 | 50 | static const char* const | ||
4078 | 51 | --- a/src/networkd.c | ||
4079 | 52 | +++ b/src/networkd.c | ||
4080 | 53 | @@ -1082,6 +1082,14 @@ | ||
4081 | 54 | g_string_append(s, " eap=TTLS\n"); | ||
4082 | 55 | break; | ||
4083 | 56 | |||
4084 | 57 | + case NETPLAN_AUTH_EAP_LEAP: | ||
4085 | 58 | + g_string_append(s, " eap=LEAP\n"); | ||
4086 | 59 | + break; | ||
4087 | 60 | + | ||
4088 | 61 | + case NETPLAN_AUTH_EAP_PWD: | ||
4089 | 62 | + g_string_append(s, " eap=PWD\n"); | ||
4090 | 63 | + break; | ||
4091 | 64 | + | ||
4092 | 65 | default: break; // LCOV_EXCL_LINE | ||
4093 | 66 | } | ||
4094 | 67 | |||
4095 | 68 | --- a/src/nm.c | ||
4096 | 69 | +++ b/src/nm.c | ||
4097 | 70 | @@ -417,6 +417,12 @@ | ||
4098 | 71 | case NETPLAN_AUTH_EAP_TTLS: | ||
4099 | 72 | g_key_file_set_string(kf, "802-1x", "eap", "ttls"); | ||
4100 | 73 | break; | ||
4101 | 74 | + case NETPLAN_AUTH_EAP_LEAP: | ||
4102 | 75 | + g_key_file_set_string(kf, "802-1x", "eap", "leap"); | ||
4103 | 76 | + break; | ||
4104 | 77 | + case NETPLAN_AUTH_EAP_PWD: | ||
4105 | 78 | + g_key_file_set_string(kf, "802-1x", "eap", "pwd"); | ||
4106 | 79 | + break; | ||
4107 | 80 | default: break; // LCOV_EXCL_LINE | ||
4108 | 81 | } | ||
4109 | 82 | |||
4110 | 83 | --- a/src/parse-nm.c | ||
4111 | 84 | +++ b/src/parse-nm.c | ||
4112 | 85 | @@ -386,6 +386,10 @@ | ||
4113 | 86 | auth->eap_method = NETPLAN_AUTH_EAP_PEAP; | ||
4114 | 87 | } else if (g_strcmp0(first_method, "ttls") == 0) { | ||
4115 | 88 | auth->eap_method = NETPLAN_AUTH_EAP_TTLS; | ||
4116 | 89 | + } else if (g_strcmp0(first_method, "leap") == 0) { | ||
4117 | 90 | + auth->eap_method = NETPLAN_AUTH_EAP_LEAP; | ||
4118 | 91 | + } else if (g_strcmp0(first_method, "pwd") == 0) { | ||
4119 | 92 | + auth->eap_method = NETPLAN_AUTH_EAP_PWD; | ||
4120 | 93 | } | ||
4121 | 94 | |||
4122 | 95 | /* If "method" (which is a list separated by ";") has more than one value, | ||
4123 | 96 | --- a/src/parse.c | ||
4124 | 97 | +++ b/src/parse.c | ||
4125 | 98 | @@ -935,6 +935,10 @@ | ||
4126 | 99 | auth->eap_method = NETPLAN_AUTH_EAP_PEAP; | ||
4127 | 100 | else if (strcmp(scalar(node), "ttls") == 0) | ||
4128 | 101 | auth->eap_method = NETPLAN_AUTH_EAP_TTLS; | ||
4129 | 102 | + else if (strcmp(scalar(node), "leap") == 0) | ||
4130 | 103 | + auth->eap_method = NETPLAN_AUTH_EAP_LEAP; | ||
4131 | 104 | + else if (strcmp(scalar(node), "pwd") == 0) | ||
4132 | 105 | + auth->eap_method = NETPLAN_AUTH_EAP_PWD; | ||
4133 | 106 | else | ||
4134 | 107 | return yaml_error(npp, node, error, "unknown EAP method '%s'", scalar(node)); | ||
4135 | 108 | return TRUE; | ||
4136 | 109 | --- a/tests/generator/test_wifis.py | ||
4137 | 110 | +++ b/tests/generator/test_wifis.py | ||
4138 | 111 | @@ -363,6 +363,54 @@ | ||
4139 | 112 | } | ||
4140 | 113 | """) | ||
4141 | 114 | |||
4142 | 115 | + def test_wifi_ieee8021x_eap_leap(self): | ||
4143 | 116 | + self.generate('''network: | ||
4144 | 117 | + version: 2 | ||
4145 | 118 | + wifis: | ||
4146 | 119 | + wl0: | ||
4147 | 120 | + access-points: | ||
4148 | 121 | + homenet: | ||
4149 | 122 | + auth: | ||
4150 | 123 | + key-management: 802.1x | ||
4151 | 124 | + method: leap | ||
4152 | 125 | + identity: some-id | ||
4153 | 126 | + password: "********"''') | ||
4154 | 127 | + | ||
4155 | 128 | + self.assert_wpa_supplicant("wl0", """ctrl_interface=/run/wpa_supplicant | ||
4156 | 129 | + | ||
4157 | 130 | +network={ | ||
4158 | 131 | + ssid="homenet" | ||
4159 | 132 | + key_mgmt=IEEE8021X | ||
4160 | 133 | + eap=LEAP | ||
4161 | 134 | + identity="some-id" | ||
4162 | 135 | + password="********" | ||
4163 | 136 | +} | ||
4164 | 137 | +""") | ||
4165 | 138 | + | ||
4166 | 139 | + def test_wifi_ieee8021x_eap_pwd(self): | ||
4167 | 140 | + self.generate('''network: | ||
4168 | 141 | + version: 2 | ||
4169 | 142 | + wifis: | ||
4170 | 143 | + wl0: | ||
4171 | 144 | + access-points: | ||
4172 | 145 | + homenet: | ||
4173 | 146 | + auth: | ||
4174 | 147 | + key-management: 802.1x | ||
4175 | 148 | + method: pwd | ||
4176 | 149 | + identity: some-id | ||
4177 | 150 | + password: "********"''') | ||
4178 | 151 | + | ||
4179 | 152 | + self.assert_wpa_supplicant("wl0", """ctrl_interface=/run/wpa_supplicant | ||
4180 | 153 | + | ||
4181 | 154 | +network={ | ||
4182 | 155 | + ssid="homenet" | ||
4183 | 156 | + key_mgmt=IEEE8021X | ||
4184 | 157 | + eap=PWD | ||
4185 | 158 | + identity="some-id" | ||
4186 | 159 | + password="********" | ||
4187 | 160 | +} | ||
4188 | 161 | +""") | ||
4189 | 162 | + | ||
4190 | 163 | |||
4191 | 164 | class TestNetworkManager(TestBase): | ||
4192 | 165 | |||
4193 | 166 | @@ -703,6 +751,82 @@ | ||
4194 | 167 | psk=******** | ||
4195 | 168 | '''}) | ||
4196 | 169 | |||
4197 | 170 | + def test_wifi_ieee8021x_leap(self): | ||
4198 | 171 | + self.generate('''network: | ||
4199 | 172 | + version: 2 | ||
4200 | 173 | + renderer: NetworkManager | ||
4201 | 174 | + wifis: | ||
4202 | 175 | + wl0: | ||
4203 | 176 | + access-points: | ||
4204 | 177 | + homenet: | ||
4205 | 178 | + auth: | ||
4206 | 179 | + key-management: 802.1x | ||
4207 | 180 | + method: leap | ||
4208 | 181 | + identity: "some-id" | ||
4209 | 182 | + password: "**********"''') | ||
4210 | 183 | + | ||
4211 | 184 | + self.assert_nm({'wl0-homenet': '''[connection] | ||
4212 | 185 | +id=netplan-wl0-homenet | ||
4213 | 186 | +type=wifi | ||
4214 | 187 | +interface-name=wl0 | ||
4215 | 188 | + | ||
4216 | 189 | +[ipv4] | ||
4217 | 190 | +method=link-local | ||
4218 | 191 | + | ||
4219 | 192 | +[ipv6] | ||
4220 | 193 | +method=ignore | ||
4221 | 194 | + | ||
4222 | 195 | +[wifi] | ||
4223 | 196 | +ssid=homenet | ||
4224 | 197 | +mode=infrastructure | ||
4225 | 198 | + | ||
4226 | 199 | +[wifi-security] | ||
4227 | 200 | +key-mgmt=ieee8021x | ||
4228 | 201 | + | ||
4229 | 202 | +[802-1x] | ||
4230 | 203 | +eap=leap | ||
4231 | 204 | +identity=some-id | ||
4232 | 205 | +password=********** | ||
4233 | 206 | +'''}) | ||
4234 | 207 | + | ||
4235 | 208 | + def test_wifi_ieee8021x_pwd(self): | ||
4236 | 209 | + self.generate('''network: | ||
4237 | 210 | + version: 2 | ||
4238 | 211 | + renderer: NetworkManager | ||
4239 | 212 | + wifis: | ||
4240 | 213 | + wl0: | ||
4241 | 214 | + access-points: | ||
4242 | 215 | + homenet: | ||
4243 | 216 | + auth: | ||
4244 | 217 | + key-management: 802.1x | ||
4245 | 218 | + method: pwd | ||
4246 | 219 | + identity: "some-id" | ||
4247 | 220 | + password: "**********"''') | ||
4248 | 221 | + | ||
4249 | 222 | + self.assert_nm({'wl0-homenet': '''[connection] | ||
4250 | 223 | +id=netplan-wl0-homenet | ||
4251 | 224 | +type=wifi | ||
4252 | 225 | +interface-name=wl0 | ||
4253 | 226 | + | ||
4254 | 227 | +[ipv4] | ||
4255 | 228 | +method=link-local | ||
4256 | 229 | + | ||
4257 | 230 | +[ipv6] | ||
4258 | 231 | +method=ignore | ||
4259 | 232 | + | ||
4260 | 233 | +[wifi] | ||
4261 | 234 | +ssid=homenet | ||
4262 | 235 | +mode=infrastructure | ||
4263 | 236 | + | ||
4264 | 237 | +[wifi-security] | ||
4265 | 238 | +key-mgmt=ieee8021x | ||
4266 | 239 | + | ||
4267 | 240 | +[802-1x] | ||
4268 | 241 | +eap=pwd | ||
4269 | 242 | +identity=some-id | ||
4270 | 243 | +password=********** | ||
4271 | 244 | +'''}) | ||
4272 | 245 | + | ||
4273 | 246 | def test_wifi_wowlan(self): | ||
4274 | 247 | self.generate('''network: | ||
4275 | 248 | version: 2 | ||
4276 | 249 | --- a/tests/parser/test_keyfile.py | ||
4277 | 250 | +++ b/tests/parser/test_keyfile.py | ||
4278 | 251 | @@ -526,6 +526,106 @@ | ||
4279 | 252 | def test_keyfile_type_wifi_eap_ttls(self): | ||
4280 | 253 | self._template_keyfile_type_wifi_eap('ttls') | ||
4281 | 254 | |||
4282 | 255 | + def test_keyfile_type_wifi_eap_leap(self): | ||
4283 | 256 | + self._template_keyfile_type_wifi_eap('leap') | ||
4284 | 257 | + | ||
4285 | 258 | + def test_keyfile_type_wifi_eap_pwd(self): | ||
4286 | 259 | + self._template_keyfile_type_wifi_eap('pwd') | ||
4287 | 260 | + | ||
4288 | 261 | + def test_keyfile_wifi_eap_leap(self): | ||
4289 | 262 | + self.generate_from_keyfile('''[connection] | ||
4290 | 263 | +type=wifi | ||
4291 | 264 | +uuid={} | ||
4292 | 265 | +permissions= | ||
4293 | 266 | +id=myid with spaces | ||
4294 | 267 | +interface-name=eth0 | ||
4295 | 268 | + | ||
4296 | 269 | +[wifi] | ||
4297 | 270 | +ssid=SOME-SSID | ||
4298 | 271 | +mode=infrastructure | ||
4299 | 272 | + | ||
4300 | 273 | +[wifi-security] | ||
4301 | 274 | +key-mgmt=ieee8021x | ||
4302 | 275 | + | ||
4303 | 276 | +[802-1x] | ||
4304 | 277 | +eap=leap | ||
4305 | 278 | +identity=some-id | ||
4306 | 279 | +password=v3rys3cr3t! | ||
4307 | 280 | + | ||
4308 | 281 | +[ipv4] | ||
4309 | 282 | +method=auto'''.format(UUID)) | ||
4310 | 283 | + self.assert_netplan({UUID: '''network: | ||
4311 | 284 | + version: 2 | ||
4312 | 285 | + wifis: | ||
4313 | 286 | + NM-{}: | ||
4314 | 287 | + renderer: NetworkManager | ||
4315 | 288 | + match: | ||
4316 | 289 | + name: "eth0" | ||
4317 | 290 | + dhcp4: true | ||
4318 | 291 | + access-points: | ||
4319 | 292 | + "SOME-SSID": | ||
4320 | 293 | + auth: | ||
4321 | 294 | + key-management: "802.1x" | ||
4322 | 295 | + method: "leap" | ||
4323 | 296 | + identity: "some-id" | ||
4324 | 297 | + password: "v3rys3cr3t!" | ||
4325 | 298 | + networkmanager: | ||
4326 | 299 | + uuid: "{}" | ||
4327 | 300 | + name: "myid with spaces" | ||
4328 | 301 | + passthrough: | ||
4329 | 302 | + connection.permissions: "" | ||
4330 | 303 | + networkmanager: | ||
4331 | 304 | + uuid: "{}" | ||
4332 | 305 | + name: "myid with spaces" | ||
4333 | 306 | +'''.format(UUID, UUID, UUID)}) | ||
4334 | 307 | + | ||
4335 | 308 | + def test_keyfile_wifi_eap_pwd(self): | ||
4336 | 309 | + self.generate_from_keyfile('''[connection] | ||
4337 | 310 | +type=wifi | ||
4338 | 311 | +uuid={} | ||
4339 | 312 | +permissions= | ||
4340 | 313 | +id=myid with spaces | ||
4341 | 314 | +interface-name=eth0 | ||
4342 | 315 | + | ||
4343 | 316 | +[wifi] | ||
4344 | 317 | +ssid=SOME-SSID | ||
4345 | 318 | +mode=infrastructure | ||
4346 | 319 | + | ||
4347 | 320 | +[wifi-security] | ||
4348 | 321 | +key-mgmt=ieee8021x | ||
4349 | 322 | + | ||
4350 | 323 | +[802-1x] | ||
4351 | 324 | +eap=pwd | ||
4352 | 325 | +identity=some-id | ||
4353 | 326 | +password=v3rys3cr3t! | ||
4354 | 327 | + | ||
4355 | 328 | +[ipv4] | ||
4356 | 329 | +method=auto'''.format(UUID)) | ||
4357 | 330 | + self.assert_netplan({UUID: '''network: | ||
4358 | 331 | + version: 2 | ||
4359 | 332 | + wifis: | ||
4360 | 333 | + NM-{}: | ||
4361 | 334 | + renderer: NetworkManager | ||
4362 | 335 | + match: | ||
4363 | 336 | + name: "eth0" | ||
4364 | 337 | + dhcp4: true | ||
4365 | 338 | + access-points: | ||
4366 | 339 | + "SOME-SSID": | ||
4367 | 340 | + auth: | ||
4368 | 341 | + key-management: "802.1x" | ||
4369 | 342 | + method: "pwd" | ||
4370 | 343 | + identity: "some-id" | ||
4371 | 344 | + password: "v3rys3cr3t!" | ||
4372 | 345 | + networkmanager: | ||
4373 | 346 | + uuid: "{}" | ||
4374 | 347 | + name: "myid with spaces" | ||
4375 | 348 | + passthrough: | ||
4376 | 349 | + connection.permissions: "" | ||
4377 | 350 | + networkmanager: | ||
4378 | 351 | + uuid: "{}" | ||
4379 | 352 | + name: "myid with spaces" | ||
4380 | 353 | +'''.format(UUID, UUID, UUID)}) | ||
4381 | 354 | + | ||
4382 | 355 | def _template_keyfile_type_wifi(self, nd_mode, nm_mode): | ||
4383 | 356 | self.generate_from_keyfile('''[connection] | ||
4384 | 357 | type=wifi | ||
4385 | 358 | --- a/doc/netplan-yaml.md | ||
4386 | 359 | +++ b/doc/netplan-yaml.md | ||
4387 | 360 | @@ -862,8 +862,9 @@ | ||
4388 | 361 | |||
4389 | 362 | - **method** (scalar) | ||
4390 | 363 | |||
4391 | 364 | - > The EAP method to use. The supported EAP methods are `tls` (TLS), | ||
4392 | 365 | - > `peap` (Protected EAP), and `ttls` (Tunneled TLS). | ||
4393 | 366 | + > The EAP method to use. The supported EAP methods are `tls` (TLS), | ||
4394 | 367 | + > `peap` (Protected EAP), `leap` (Lightweight EAP), `pwd` (EAP Password) | ||
4395 | 368 | + > and `ttls` (Tunneled TLS). | ||
4396 | 369 | |||
4397 | 370 | - **identity** (scalar) | ||
4398 | 371 | |||
4399 | diff --git a/debian/patches/lp2041727/0004-cli-utils-introduce-systemctl_is_installed-helper.patch b/debian/patches/lp2041727/0004-cli-utils-introduce-systemctl_is_installed-helper.patch | |||
4400 | 372 | new file mode 100644 | 0 | new file mode 100644 |
4401 | index 0000000..2ac4c6b | |||
4402 | --- /dev/null | |||
4403 | +++ b/debian/patches/lp2041727/0004-cli-utils-introduce-systemctl_is_installed-helper.patch | |||
4404 | @@ -0,0 +1,63 @@ | |||
4405 | 1 | From: =?utf-8?q?Lukas_M=C3=A4rdian?= <slyon@ubuntu.com> | ||
4406 | 2 | Date: Thu, 25 Jan 2024 12:40:06 +0100 | ||
4407 | 3 | Subject: cli:utils: introduce systemctl_is_installed helper | ||
4408 | 4 | |||
4409 | 5 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2041727 | ||
4410 | 6 | Origin: https://github.com/canonical/netplan/pull/421 | ||
4411 | 7 | --- | ||
4412 | 8 | netplan_cli/cli/utils.py | 10 ++++++++++ | ||
4413 | 9 | tests/test_utils.py | 20 ++++++++++++++++++++ | ||
4414 | 10 | 2 files changed, 30 insertions(+) | ||
4415 | 11 | |||
4416 | 12 | diff --git a/netplan_cli/cli/utils.py b/netplan_cli/cli/utils.py | ||
4417 | 13 | index a5f60c9..f913630 100644 | ||
4418 | 14 | --- a/netplan_cli/cli/utils.py | ||
4419 | 15 | +++ b/netplan_cli/cli/utils.py | ||
4420 | 16 | @@ -148,6 +148,16 @@ def systemctl_is_masked(unit_pattern): | ||
4421 | 17 | return False | ||
4422 | 18 | |||
4423 | 19 | |||
4424 | 20 | +def systemctl_is_installed(unit_pattern): | ||
4425 | 21 | + '''Return True if returncode is other than "not-found" (4)''' | ||
4426 | 22 | + res = subprocess.run(['systemctl', 'is-enabled', unit_pattern], | ||
4427 | 23 | + stdout=subprocess.PIPE, stderr=subprocess.PIPE, | ||
4428 | 24 | + text=True) | ||
4429 | 25 | + if res.returncode != 4: | ||
4430 | 26 | + return True | ||
4431 | 27 | + return False | ||
4432 | 28 | + | ||
4433 | 29 | + | ||
4434 | 30 | def systemctl_daemon_reload(): | ||
4435 | 31 | '''Reload systemd unit files from disk and re-calculate its dependencies''' | ||
4436 | 32 | subprocess.check_call(['systemctl', 'daemon-reload']) | ||
4437 | 33 | diff --git a/tests/test_utils.py b/tests/test_utils.py | ||
4438 | 34 | index b2a1657..eefd334 100644 | ||
4439 | 35 | --- a/tests/test_utils.py | ||
4440 | 36 | +++ b/tests/test_utils.py | ||
4441 | 37 | @@ -354,6 +354,26 @@ class TestUtils(unittest.TestCase): | ||
4442 | 38 | ['systemctl', 'is-enabled', 'some.service'] | ||
4443 | 39 | ]) | ||
4444 | 40 | |||
4445 | 41 | + def test_systemctl_is_installed(self): | ||
4446 | 42 | + self.mock_cmd = MockCmd('systemctl') | ||
4447 | 43 | + self.mock_cmd.set_returncode(0) | ||
4448 | 44 | + path_env = os.environ['PATH'] | ||
4449 | 45 | + os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env | ||
4450 | 46 | + self.assertTrue(utils.systemctl_is_installed('some.service')) | ||
4451 | 47 | + self.assertEqual(self.mock_cmd.calls(), [ | ||
4452 | 48 | + ['systemctl', 'is-enabled', 'some.service'] | ||
4453 | 49 | + ]) | ||
4454 | 50 | + | ||
4455 | 51 | + def test_systemctl_is_installed_false(self): | ||
4456 | 52 | + self.mock_cmd = MockCmd('systemctl') | ||
4457 | 53 | + self.mock_cmd.set_returncode(4) | ||
4458 | 54 | + path_env = os.environ['PATH'] | ||
4459 | 55 | + os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env | ||
4460 | 56 | + self.assertFalse(utils.systemctl_is_installed('some.service')) | ||
4461 | 57 | + self.assertEqual(self.mock_cmd.calls(), [ | ||
4462 | 58 | + ['systemctl', 'is-enabled', 'some.service'] | ||
4463 | 59 | + ]) | ||
4464 | 60 | + | ||
4465 | 61 | def test_systemctl_daemon_reload(self): | ||
4466 | 62 | self.mock_cmd = MockCmd('systemctl') | ||
4467 | 63 | path_env = os.environ['PATH'] | ||
4468 | diff --git a/debian/patches/lp2041727/0005-Update-ovs.py-to-check-if-ovsdb-server.service-is-in.patch b/debian/patches/lp2041727/0005-Update-ovs.py-to-check-if-ovsdb-server.service-is-in.patch | |||
4469 | 0 | new file mode 100644 | 64 | new file mode 100644 |
4470 | index 0000000..472c6bc | |||
4471 | --- /dev/null | |||
4472 | +++ b/debian/patches/lp2041727/0005-Update-ovs.py-to-check-if-ovsdb-server.service-is-in.patch | |||
4473 | @@ -0,0 +1,75 @@ | |||
4474 | 1 | From: Tom <96974474+viciousdrop@users.noreply.github.com> | ||
4475 | 2 | Date: Mon, 6 Nov 2023 20:38:14 +0800 | ||
4476 | 3 | Subject: Update ovs.py to check if ovsdb-server.service is installed before | ||
4477 | 4 | throwing an error | ||
4478 | 5 | |||
4479 | 6 | Adopted changes outlined in this bug | ||
4480 | 7 | Credit: https://github.com/brianfinley | ||
4481 | 8 | https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2041727 | ||
4482 | 9 | "WARNING:root:Cannot call Open vSwitch: ovsdb-server.service is not running." | ||
4483 | 10 | |||
4484 | 11 | Co-Authored-by: Lukas Märdian <slyon@ubuntu.com> | ||
4485 | 12 | |||
4486 | 13 | This patch also includes a trivial change from | ||
4487 | 14 | https://github.com/canonical/netplan/commit/95e4d51435c2e9c9a6b7382e39c0306200ee1b9b | ||
4488 | 15 | |||
4489 | 16 | Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2041727 | ||
4490 | 17 | Origin: https://github.com/canonical/netplan/pull/421 | ||
4491 | 18 | --- | ||
4492 | 19 | netplan_cli/cli/commands/apply.py | 4 +++- | ||
4493 | 20 | netplan_cli/cli/ovs.py | 9 ++++++++- | ||
4494 | 21 | 2 files changed, 11 insertions(+), 2 deletions(-) | ||
4495 | 22 | |||
4496 | 23 | diff --git a/netplan_cli/cli/commands/apply.py b/netplan_cli/cli/commands/apply.py | ||
4497 | 24 | index 066f496..9c88a3c 100644 | ||
4498 | 25 | --- a/netplan_cli/cli/commands/apply.py | ||
4499 | 26 | +++ b/netplan_cli/cli/commands/apply.py | ||
4500 | 27 | @@ -31,7 +31,7 @@ import time | ||
4501 | 28 | from .. import utils | ||
4502 | 29 | from ...configmanager import ConfigManager, ConfigurationError | ||
4503 | 30 | from ..sriov import apply_sriov_config | ||
4504 | 31 | -from ..ovs import OvsDbServerNotRunning, apply_ovs_cleanup | ||
4505 | 32 | +from ..ovs import OvsDbServerNotRunning, OvsDbServerNotInstalled, apply_ovs_cleanup | ||
4506 | 33 | |||
4507 | 34 | |||
4508 | 35 | OVS_CLEANUP_SERVICE = 'netplan-ovs-cleanup.service' | ||
4509 | 36 | @@ -433,3 +433,5 @@ class NetplanApply(utils.NetplanCommand): | ||
4510 | 37 | sys.exit(1) | ||
4511 | 38 | except OvsDbServerNotRunning as e: | ||
4512 | 39 | logging.warning('Cannot call Open vSwitch: {}.'.format(e)) | ||
4513 | 40 | + except OvsDbServerNotInstalled as e: | ||
4514 | 41 | + logging.debug('Cannot call Open vSwitch: %s.', e) | ||
4515 | 42 | diff --git a/netplan_cli/cli/ovs.py b/netplan_cli/cli/ovs.py | ||
4516 | 43 | index 0ba0482..0caab72 100644 | ||
4517 | 44 | --- a/netplan_cli/cli/ovs.py | ||
4518 | 45 | +++ b/netplan_cli/cli/ovs.py | ||
4519 | 46 | @@ -20,7 +20,7 @@ import os | ||
4520 | 47 | import subprocess | ||
4521 | 48 | import re | ||
4522 | 49 | |||
4523 | 50 | -from .utils import systemctl_is_active | ||
4524 | 51 | +from .utils import systemctl_is_active, systemctl_is_installed | ||
4525 | 52 | |||
4526 | 53 | OPENVSWITCH_OVS_VSCTL = '/usr/bin/ovs-vsctl' | ||
4527 | 54 | OPENVSWITCH_OVSDB_SERVER_UNIT = 'ovsdb-server.service' | ||
4528 | 55 | @@ -43,6 +43,10 @@ class OvsDbServerNotRunning(Exception): | ||
4529 | 56 | pass | ||
4530 | 57 | |||
4531 | 58 | |||
4532 | 59 | +class OvsDbServerNotInstalled(Exception): | ||
4533 | 60 | + pass | ||
4534 | 61 | + | ||
4535 | 62 | + | ||
4536 | 63 | def _del_col(type, iface, column, value): | ||
4537 | 64 | """Cleanup values from a column (i.e. "column=value")""" | ||
4538 | 65 | default = DEFAULTS.get(column) | ||
4539 | 66 | @@ -125,6 +129,9 @@ def apply_ovs_cleanup(config_manager, ovs_old, ovs_current): # pragma: nocover | ||
4540 | 67 | Also filter for individual settings tagged netplan/<column>[/<key]=value | ||
4541 | 68 | in external-ids and clear them if they have been set by netplan. | ||
4542 | 69 | """ | ||
4543 | 70 | + if not systemctl_is_installed(OPENVSWITCH_OVSDB_SERVER_UNIT): | ||
4544 | 71 | + raise OvsDbServerNotInstalled("Cannot apply OVS cleanup: %s is 'not-found'" % | ||
4545 | 72 | + OPENVSWITCH_OVSDB_SERVER_UNIT) | ||
4546 | 73 | if not systemctl_is_active(OPENVSWITCH_OVSDB_SERVER_UNIT): | ||
4547 | 74 | raise OvsDbServerNotRunning('{} is not running'.format(OPENVSWITCH_OVSDB_SERVER_UNIT)) | ||
4548 | 75 | |||
4549 | diff --git a/debian/patches/series b/debian/patches/series | |||
4550 | index 4d9d078..8021670 100644 | |||
4551 | --- a/debian/patches/series | |||
4552 | +++ b/debian/patches/series | |||
4553 | @@ -1,11 +1,6 @@ | |||
4565 | 1 | 0001-parse-allow-COMMON_LINK_HANDLERS-for-VRFs-LP-2031421.patch | 1 | 0001-parse-nm-wg-append-the-correct-prefix-to-IPv6-addres.patch |
4566 | 2 | 0002-test-ovs-Avoid-NetworkManager-taking-contol-breaking.patch | 2 | lp2041727/0004-cli-utils-introduce-systemctl_is_installed-helper.patch |
4567 | 3 | 0003-util-don-t-return-a-placeholder-netdef-in-the-iterat.patch | 3 | lp2041727/0005-Update-ovs.py-to-check-if-ovsdb-server.service-is-in.patch |
4568 | 4 | lp2034067/0004-tunnels-validation-do-not-error-out-if-local-is-not-.patch | 4 | 0007-tests-assert-generated-.service-files-in-assert_srio.patch |
4569 | 5 | lp2034067/0005-tests-add-some-integration-tests-without-the-local-a.patch | 5 | 0008-tests-sriov-test-if-the-generated-netplan-rebind-ser.patch |
4570 | 6 | lp2034595/0006-apply-bring-lo-back-up-if-it-s-managed-by-NM.patch | 6 | 0009-sriov-don-t-generate-duplicate-entries-in-the-rebind.patch |
4560 | 7 | lp2034595/0007-apply-don-t-assume-the-NM-loopback-connection-is-cal.patch | ||
4561 | 8 | lp2039821/0008-wireguard-ignore-empty-endpoints.patch | ||
4562 | 9 | lp2039825/0009-auth-add-support-for-LEAP-and-EAP-PWD.patch | ||
4563 | 10 | lp1809994/0010-parse-improve-the-parsing-of-access-points-LP-180999.patch | ||
4564 | 11 | lp1809994/0011-wifi-replace-the-previously-defined-AP-with-the-new-.patch | ||
4571 | diff --git a/debian/rules b/debian/rules | |||
4572 | index 6f54c41..2780683 100755 | |||
4573 | --- a/debian/rules | |||
4574 | +++ b/debian/rules | |||
4575 | @@ -19,7 +19,3 @@ execute_after_dh_auto_install: | |||
4576 | 19 | rm -rf debian/tmp/usr/lib/python3/dist-packages/netplan/__pycache__/ | 19 | rm -rf debian/tmp/usr/lib/python3/dist-packages/netplan/__pycache__/ |
4577 | 20 | # Drop legacy symlink | 20 | # Drop legacy symlink |
4578 | 21 | rm debian/tmp/lib/netplan/generate | 21 | rm debian/tmp/lib/netplan/generate |
4579 | 22 | # Fix non-usrmerged paths & drop legacy symlink | ||
4580 | 23 | # rm -rf debian/tmp/lib | ||
4581 | 24 | # mkdir -p debian/tmp/usr/lib/systemd/system-generators | ||
4582 | 25 | # ln -s /usr/libexec/netplan/generate debian/tmp/usr/lib/systemd/system-generators/netplan | ||
4583 | diff --git a/debian/tests/prep-testbed.sh b/debian/tests/prep-testbed.sh | |||
4584 | index 6729083..0866460 100755 | |||
4585 | --- a/debian/tests/prep-testbed.sh | |||
4586 | +++ b/debian/tests/prep-testbed.sh | |||
4587 | @@ -5,6 +5,9 @@ if [ "$(systemctl is-active NetworkManager.service)" = active ]; then | |||
4588 | 5 | systemctl stop NetworkManager.service | 5 | systemctl stop NetworkManager.service |
4589 | 6 | fi | 6 | fi |
4590 | 7 | 7 | ||
4591 | 8 | # Make sure the system is ready before starting our tests | ||
4592 | 9 | systemctl daemon-reload | ||
4593 | 10 | |||
4594 | 8 | # only relevant on Debian | 11 | # only relevant on Debian |
4595 | 9 | dpkg-vendor --is Debian || exit 0 | 12 | dpkg-vendor --is Debian || exit 0 |
4596 | 10 | 13 | ||
4597 | diff --git a/doc/apidoc/inc-netplan.md b/doc/apidoc/inc-netplan.md | |||
4598 | 11 | new file mode 100644 | 14 | new file mode 100644 |
4599 | index 0000000..cdee9bf | |||
4600 | --- /dev/null | |||
4601 | +++ b/doc/apidoc/inc-netplan.md | |||
4602 | @@ -0,0 +1,4 @@ | |||
4603 | 1 | # netplan.h | ||
4604 | 2 | |||
4605 | 3 | ```{autodoxygenfile} include/netplan.h | ||
4606 | 4 | ``` | ||
4607 | diff --git a/doc/apidoc/inc-parse-nm.md b/doc/apidoc/inc-parse-nm.md | |||
4608 | 0 | new file mode 100644 | 5 | new file mode 100644 |
4609 | index 0000000..3129f1d | |||
4610 | --- /dev/null | |||
4611 | +++ b/doc/apidoc/inc-parse-nm.md | |||
4612 | @@ -0,0 +1,4 @@ | |||
4613 | 1 | # parse-nm.h | ||
4614 | 2 | |||
4615 | 3 | ```{autodoxygenfile} include/parse-nm.h | ||
4616 | 4 | ``` | ||
4617 | diff --git a/doc/apidoc/inc-parse.md b/doc/apidoc/inc-parse.md | |||
4618 | 0 | new file mode 100644 | 5 | new file mode 100644 |
4619 | index 0000000..733585a | |||
4620 | --- /dev/null | |||
4621 | +++ b/doc/apidoc/inc-parse.md | |||
4622 | @@ -0,0 +1,4 @@ | |||
4623 | 1 | # parse.h | ||
4624 | 2 | |||
4625 | 3 | ```{autodoxygenfile} include/parse.h | ||
4626 | 4 | ``` | ||
4627 | diff --git a/doc/apidoc/inc-types.md b/doc/apidoc/inc-types.md | |||
4628 | 0 | new file mode 100644 | 5 | new file mode 100644 |
4629 | index 0000000..767296e | |||
4630 | --- /dev/null | |||
4631 | +++ b/doc/apidoc/inc-types.md | |||
4632 | @@ -0,0 +1,4 @@ | |||
4633 | 1 | # types.h | ||
4634 | 2 | |||
4635 | 3 | ```{autodoxygenfile} include/types.h | ||
4636 | 4 | ``` | ||
4637 | diff --git a/doc/apidoc/inc-util.md b/doc/apidoc/inc-util.md | |||
4638 | 0 | new file mode 100644 | 5 | new file mode 100644 |
4639 | index 0000000..7fc3c0c | |||
4640 | --- /dev/null | |||
4641 | +++ b/doc/apidoc/inc-util.md | |||
4642 | @@ -0,0 +1,4 @@ | |||
4643 | 1 | # util.h | ||
4644 | 2 | |||
4645 | 3 | ```{autodoxygenfile} include/util.h | ||
4646 | 4 | ``` | ||
4647 | diff --git a/doc/apidoc/index.md b/doc/apidoc/index.md | |||
4648 | 0 | new file mode 100644 | 5 | new file mode 100644 |
4649 | index 0000000..927ef3d | |||
4650 | --- /dev/null | |||
4651 | +++ b/doc/apidoc/index.md | |||
4652 | @@ -0,0 +1,52 @@ | |||
4653 | 1 | # Reference: libnetplan API | ||
4654 | 2 | |||
4655 | 3 | ## Public headers | ||
4656 | 4 | ```{toctree} | ||
4657 | 5 | --- | ||
4658 | 6 | maxdepth: 1 | ||
4659 | 7 | --- | ||
4660 | 8 | inc-netplan | ||
4661 | 9 | ``` | ||
4662 | 10 | > ```{autodoxygenfile} include/netplan.h | ||
4663 | 11 | > :sections: briefdescription | ||
4664 | 12 | > ``` | ||
4665 | 13 | |||
4666 | 14 | ```{toctree} | ||
4667 | 15 | --- | ||
4668 | 16 | maxdepth: 1 | ||
4669 | 17 | --- | ||
4670 | 18 | inc-parse-nm | ||
4671 | 19 | ``` | ||
4672 | 20 | > ```{autodoxygenfile} include/parse-nm.h | ||
4673 | 21 | > :sections: briefdescription | ||
4674 | 22 | > ``` | ||
4675 | 23 | |||
4676 | 24 | ```{toctree} | ||
4677 | 25 | --- | ||
4678 | 26 | maxdepth: 1 | ||
4679 | 27 | --- | ||
4680 | 28 | inc-parse | ||
4681 | 29 | ``` | ||
4682 | 30 | > ```{autodoxygenfile} include/parse.h | ||
4683 | 31 | > :sections: briefdescription | ||
4684 | 32 | > ``` | ||
4685 | 33 | |||
4686 | 34 | ```{toctree} | ||
4687 | 35 | --- | ||
4688 | 36 | maxdepth: 1 | ||
4689 | 37 | --- | ||
4690 | 38 | inc-types | ||
4691 | 39 | ``` | ||
4692 | 40 | > ```{autodoxygenfile} include/types.h | ||
4693 | 41 | > :sections: briefdescription | ||
4694 | 42 | > ``` | ||
4695 | 43 | |||
4696 | 44 | ```{toctree} | ||
4697 | 45 | --- | ||
4698 | 46 | maxdepth: 1 | ||
4699 | 47 | --- | ||
4700 | 48 | inc-util | ||
4701 | 49 | ``` | ||
4702 | 50 | > ```{autodoxygenfile} include/util.h | ||
4703 | 51 | > :sections: briefdescription | ||
4704 | 52 | > ``` | ||
4705 | 0 | \ No newline at end of file | 53 | \ No newline at end of file |
4706 | diff --git a/doc/conf.py b/doc/conf.py | |||
4707 | index 8e5aef7..061173e 100644 | |||
4708 | --- a/doc/conf.py | |||
4709 | +++ b/doc/conf.py | |||
4710 | @@ -27,10 +27,32 @@ author = 'Netplan team' | |||
4711 | 27 | # Add any Sphinx extension module names here, as strings. They can be | 27 | # Add any Sphinx extension module names here, as strings. They can be |
4712 | 28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | 28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
4713 | 29 | # ones. | 29 | # ones. |
4715 | 30 | extensions = ['sphinx_design', 'myst_parser', 'sphinx_copybutton'] | 30 | extensions = ['sphinx_design', 'myst_parser', 'sphinx_copybutton', 'sphinxcontrib.spelling', 'breathe'] |
4716 | 31 | myst_enable_extensions = ["colon_fence"] | 31 | myst_enable_extensions = ["colon_fence"] |
4717 | 32 | smartquotes_action = 'qe' | 32 | smartquotes_action = 'qe' |
4718 | 33 | 33 | ||
4719 | 34 | # Doxygen | ||
4720 | 35 | # https://breathe.readthedocs.io/en/latest/directives.html | ||
4721 | 36 | # breathe_projects = {"Netplan": "../doxyxml/"} | ||
4722 | 37 | breathe_projects_source = {"auto-apidoc": ("../", [ | ||
4723 | 38 | "include/netplan.h", | ||
4724 | 39 | "include/parse-nm.h", | ||
4725 | 40 | "include/parse.h", | ||
4726 | 41 | "include/types.h", | ||
4727 | 42 | "include/util.h", | ||
4728 | 43 | "src/error.c", | ||
4729 | 44 | "src/names.c", | ||
4730 | 45 | "src/netplan.c", | ||
4731 | 46 | "src/parse-nm.c", | ||
4732 | 47 | "src/parse.c", | ||
4733 | 48 | "src/types.c", | ||
4734 | 49 | "src/util.c", | ||
4735 | 50 | "src/validation.c", | ||
4736 | 51 | ])} | ||
4737 | 52 | # breathe_doxygen_config_options = | ||
4738 | 53 | # breathe_doxygen_aliases = | ||
4739 | 54 | breathe_default_project = "auto-apidoc" | ||
4740 | 55 | |||
4741 | 34 | # Add any paths that contain templates here, relative to this directory. | 56 | # Add any paths that contain templates here, relative to this directory. |
4742 | 35 | templates_path = ['_templates'] | 57 | templates_path = ['_templates'] |
4743 | 36 | 58 | ||
4744 | @@ -57,3 +79,9 @@ html_logo = 'netplan.svg' | |||
4745 | 57 | 79 | ||
4746 | 58 | # -- Options for MyST -------------------------------------------------------- | 80 | # -- Options for MyST -------------------------------------------------------- |
4747 | 59 | myst_title_to_header = True | 81 | myst_title_to_header = True |
4748 | 82 | suppress_warnings = ['myst.xref_missing'] | ||
4749 | 83 | |||
4750 | 84 | # Spelling | ||
4751 | 85 | spelling_lang = 'en_US' | ||
4752 | 86 | tokenizer_lang = 'en_US' | ||
4753 | 87 | spelling_show_suggestions = True | ||
4754 | diff --git a/doc/contribute-docs.md b/doc/contribute-docs.md | |||
4755 | 60 | new file mode 100644 | 88 | new file mode 100644 |
4756 | index 0000000..fc7e459 | |||
4757 | --- /dev/null | |||
4758 | +++ b/doc/contribute-docs.md | |||
4759 | @@ -0,0 +1,26 @@ | |||
4760 | 1 | # Contribute Documentation | ||
4761 | 2 | |||
4762 | 3 | ## Reporting an issue | ||
4763 | 4 | |||
4764 | 5 | If you find any issue in Netplan's documentation please [file a bugreport](https://bugs.launchpad.net/netplan/+filebug?field.tags=documentation) | ||
4765 | 6 | about it in our bugtracker at Launchpad. Remember adding a `documentation` tag | ||
4766 | 7 | to it. | ||
4767 | 8 | |||
4768 | 9 | ## Modifying documentation online | ||
4769 | 10 | |||
4770 | 11 | Each documentation page, rendered on the web contains an "Edit this page" at | ||
4771 | 12 | the top-right of every page, besides the documentation title. Clicking this | ||
4772 | 13 | button will lead you to the GitHub web-editor where you can easily propose | ||
4773 | 14 | changes to the corresponding page. | ||
4774 | 15 | |||
4775 | 16 | Please remember to first check the [latest version](https://netplan.readthedocs.io/en/latest/) | ||
4776 | 17 | of our documentation and make your proposal based on that revision. | ||
4777 | 18 | |||
4778 | 19 | ## Creating a pull-request | ||
4779 | 20 | |||
4780 | 21 | If you want to follow a git development workflow, you can also checkout the | ||
4781 | 22 | [Netplan repository](https://github.com/canonical/netplan) and contribute your | ||
4782 | 23 | changes as [pull-requests](https://github.com/canonical/netplan/pulls), putting | ||
4783 | 24 | the `documentation` label for better visibility. | ||
4784 | 25 | |||
4785 | 26 | Please see the `doc/` and `examples/` directories for relevant files. | ||
4786 | diff --git a/doc/howto.md b/doc/howto.md | |||
4787 | index 5c46a86..dd8d00d 100644 | |||
4788 | --- a/doc/howto.md | |||
4789 | +++ b/doc/howto.md | |||
4790 | @@ -4,4 +4,5 @@ | |||
4791 | 4 | examples | 4 | examples |
4792 | 5 | dbus-config | 5 | dbus-config |
4793 | 6 | netplan-everywhere | 6 | netplan-everywhere |
4794 | 7 | contribute-docs | ||
4795 | 7 | ``` | 8 | ``` |
4796 | diff --git a/doc/netplan-everywhere.md b/doc/netplan-everywhere.md | |||
4797 | index 1ae30ca..ae346fe 100644 | |||
4798 | --- a/doc/netplan-everywhere.md | |||
4799 | +++ b/doc/netplan-everywhere.md | |||
4800 | @@ -1,6 +1,6 @@ | |||
4801 | 1 | # Desktop integration | 1 | # Desktop integration |
4802 | 2 | 2 | ||
4804 | 3 | ## NetworkManager YAML settings backend (Netplan everywhere) | 3 | ## NetworkManager YAML settings backend |
4805 | 4 | 4 | ||
4806 | 5 | NetworkManager is the tool used by Ubuntu Desktop systems to manage | 5 | NetworkManager is the tool used by Ubuntu Desktop systems to manage |
4807 | 6 | network devices such as Ethernet and Wifi adapters. While it is a great | 6 | network devices such as Ethernet and Wifi adapters. While it is a great |
4808 | @@ -8,85 +8,79 @@ tool for the job and users can directly use it through the command line | |||
4809 | 8 | and the graphical interfaces to configure their devices, Ubuntu has its | 8 | and the graphical interfaces to configure their devices, Ubuntu has its |
4810 | 9 | own way of describing and storing network configuration via Netplan. | 9 | own way of describing and storing network configuration via Netplan. |
4811 | 10 | 10 | ||
4819 | 11 | On Ubuntu, NetworkManager uses (or will use, depending on when you are | 11 | On Ubuntu 23.10 "Mantic Minotaur" and later, NetworkManager uses Netplan APIs |
4820 | 12 | reading this) Netplan's APIs to save the configuration created by the | 12 | to save the configuration created using any of its graphical or programmatic |
4821 | 13 | user using any of its interfaces. Our goal is to have a centralized place | 13 | interfaces. This leads to having a centralized location to store network |
4822 | 14 | to store network configuration. In the Desktop it's convenient to use | 14 | configuration. On the Desktop, it's convenient to use graphical tools for |
4823 | 15 | graphical tools for configuration when they are available, so nothing will | 15 | configuration when they are available, so nothing changes from the user |
4824 | 16 | change from the user perspective, only the way the configuration is | 16 | perspective; only the way the system handles the configuration in the background. |
4818 | 17 | handled under the hood. | ||
4825 | 18 | 17 | ||
4827 | 19 | For more information on Netplan, check https://netplan.io/ | 18 | For more information on Netplan, see [https://netplan.io](https://netplan.io). |
4828 | 20 | 19 | ||
4830 | 21 | For more information on NetworkManager, check https://networkmanager.dev/ | 20 | For more information on NetworkManager, see [https://networkmanager.dev](https://networkmanager.dev). |
4831 | 22 | 21 | ||
4832 | 23 | ## How it works | 22 | ## How it works |
4833 | 24 | 23 | ||
4834 | 25 | Every time a non-temporary connection is created in NetworkManager, instead | 24 | Every time a non-temporary connection is created in NetworkManager, instead |
4843 | 26 | of persisting the original .nmconnection file, it will create a Netplan YAML | 25 | of persisting the original `.nmconnection` file, it creates a Netplan YAML |
4844 | 27 | at `/etc/netplan` called `90-NM-<connection UUID>.yaml`. After creating the | 26 | file in `/etc/netplan/` called `90-NM-<connection UUID>.yaml`. After creating |
4845 | 28 | file, NetworkManager will call the Netplan generator to emit the configuration | 27 | the file, NetworkManager calls the Netplan generator to provide the |
4846 | 29 | for that connection. Connections that are temporary, like the ones created | 28 | configuration for that connection. Connections that are temporary, like the ones |
4847 | 30 | for virtual network interfaces when you connect to a VPN for example, are not | 29 | created for virtual network interfaces when you connect to a VPN for example, |
4848 | 31 | persisted as Netplan files. The reason for that is that these interfaces are | 30 | are not persisted as Netplan files. The reason for that is that these interfaces |
4849 | 32 | usually managed by external services and we don't want to cause any unexpected | 31 | are usually managed by external services and we don't want to cause any |
4850 | 33 | change that would affect them. | 32 | unexpected change that would affect them. |
4851 | 34 | 33 | ||
4853 | 35 | ## How to install it | 34 | ## How to use |
4854 | 36 | 35 | ||
4860 | 37 | ### Creating a backup of your current configuration | 36 | ### Installing NetworkManager |
4856 | 38 | |||
4857 | 39 | The new NetworkManager will remove connection profiles that you eventually | ||
4858 | 40 | modify from `/etc/NetworkManager`. So you might want to create a copy of all | ||
4859 | 41 | your connection profiles before installing the new network-manager package: | ||
4861 | 42 | 37 | ||
4862 | 38 | The NetworkManager 1.44.2 package containing the Netplan integration patch | ||
4863 | 39 | is available by default in Ubuntu 23.10 "Mantic Minotaur" and later as part of | ||
4864 | 40 | the official Ubuntu archive. | ||
4865 | 43 | ``` | 41 | ``` |
4868 | 44 | $ mkdir ~/NetworkManager.bak && cd ~/NetworkManager.bak/ | 42 | $ sudo apt update |
4869 | 45 | $ sudo cp -r /etc/NetworkManager/system-connections . | 43 | $ sudo apt install network-manager |
4870 | 46 | ``` | 44 | ``` |
4871 | 47 | 45 | ||
4877 | 48 | In any case, a backup will be created automatically for you at | 46 | ### User interface |
4873 | 49 | `/root/NetworkManager.bak` during package installation. | ||
4874 | 50 | |||
4875 | 51 | And also keep a copy of all the original network-manager related packages in | ||
4876 | 52 | case you want to revert to the previous installation: | ||
4878 | 53 | 47 | ||
4882 | 54 | ``` | 48 | From this point on, Netplan is aware of all your network configuration and |
4883 | 55 | $ apt download gir1.2-nm-1.0 libnm0 network-manager network-manager-config-connectivity-ubuntu | 49 | you can query it using its CLI tools, such as `sudo netplan get` or `sudo |
4884 | 56 | ``` | 50 | netplan status`. All while keeping untouched the traditional way of modifying |
4885 | 51 | it using NetworkManager (graphical UI, GNOME Quick Settings, `nmcli`, | ||
4886 | 52 | `nmtui`, D-Bus APIs, ...). | ||
4887 | 57 | 53 | ||
4889 | 58 | ### Installing NetworkManager | 54 | ### Management of connection profiles |
4890 | 59 | 55 | ||
4894 | 60 | The NetworkManager 1.42.0 package containing the Netplan integration patch | 56 | The NetworkManager-Netplan integration imports connection profiles from |
4895 | 61 | is currently available as a PPA. In order to install it, you will need to | 57 | `/etc/NetworkManager/system-connections/` to Netplan during the installation |
4896 | 62 | have `netplan.io >= 0.106` installed in your system (it is available in Lunar). | 58 | process. It automatically creates a copy of all your connection profiles during |
4897 | 59 | the installation of the new network-manager package in | ||
4898 | 60 | `/root/NetworkManager.bak/system-connections/`. The same migration happens | ||
4899 | 61 | in the background whenever you add or modify any connection profile. | ||
4900 | 63 | 62 | ||
4901 | 63 | You can observe this migration on the `apt-get`` command line. Watch for | ||
4902 | 64 | logs like the following: | ||
4903 | 64 | ``` | 65 | ``` |
4907 | 65 | $ sudo add-apt-repository ppa:canonical-foundations/networkmanager-netplan | 66 | Setting up network-manager (1.44.2-1ubuntu1.2) ... |
4908 | 66 | $ sudo apt update | 67 | Migrating HomeNet (9d087126-ae71-4992-9e0a-18c5ea92a4ed) to /etc/netplan |
4909 | 67 | $ sudo apt install network-manager | 68 | Migrating eduroam (37d643bb-d81d-4186-9402-7b47632c59b1) to /etc/netplan |
4910 | 69 | Migrating DebConf (f862be9c-fb06-4c0f-862f-c8e210ca4941) to /etc/netplan | ||
4911 | 68 | ``` | 70 | ``` |
4912 | 69 | 71 | ||
4926 | 70 | ## How connections are managed from now on | 72 | For example, if you have a Wifi connection, you will not find the connection |
4927 | 71 | 73 | profile file at `/etc/NetworkManager/system-connections/` anymore. Instead, | |
4928 | 72 | After installing the new NetworkManager, your existing connection profiles | 74 | the system removes the profile file, and Netplan creates a new YAML file called |
4929 | 73 | will not be imported to Netplan YAML files, only new connections and the | 75 | `90-NM-<connection UUID>.yaml` in `/etc/netplan/` and generates a new ephemeral |
4930 | 74 | existing ones you eventually modify. | 76 | profile in `/run/NetworkManager/system-connections/`. |
4918 | 75 | |||
4919 | 76 | For example, if you have a Wifi connection, you will find the connection | ||
4920 | 77 | profile file at `/etc/NetworkManager/system-connections`. If you modify it | ||
4921 | 78 | using one of the NetworkManager's interfaces (or delete and create a new one), | ||
4922 | 79 | the respective file will be removed from `/etc/NetworkManager/system-connections`, | ||
4923 | 80 | a Netplan YAML called `90-NM-<connection UUID>.yaml` will be created at | ||
4924 | 81 | `/etc/netplan` and a new profile will be generated and stored at | ||
4925 | 82 | `/run/NetworkManager/system-connections`. | ||
4931 | 83 | 77 | ||
4932 | 84 | ## Limitation | 78 | ## Limitation |
4933 | 85 | 79 | ||
4935 | 86 | Netplan doesn't yet support all the configuration available in | 80 | Netplan doesn't yet support all the configuration options available in |
4936 | 87 | NetworkManager (or doesn't know how to interpret some of the keywords | 81 | NetworkManager (or doesn't know how to interpret some of the keywords |
4937 | 88 | found in the keyfile). After creating a new connection you might find | 82 | found in the keyfile). After creating a new connection you might find |
4939 | 89 | a section called "passthrough" in your YAML file, like in the example below: | 83 | a section called `passthrough` in your YAML file, like in the example below: |
4940 | 90 | 84 | ||
4941 | 91 | ```yaml | 85 | ```yaml |
4942 | 92 | network: | 86 | network: |
4943 | @@ -113,12 +107,12 @@ network: | |||
4944 | 113 | proxy._: "" | 107 | proxy._: "" |
4945 | 114 | ``` | 108 | ``` |
4946 | 115 | 109 | ||
4948 | 116 | All the configuration under the "passthrough" mapping will be added to | 110 | All the configuration under the `passthrough` mapping is added to |
4949 | 117 | the `.nmconnection` file as they are. | 111 | the `.nmconnection` file as they are. |
4950 | 118 | 112 | ||
4954 | 119 | In cases where the connection type is not supported by Netplan the | 113 | In cases where the connection type is not supported by Netplan, the system uses |
4955 | 120 | `nm-devices` network type will be used. The example below is an OpenVPN | 114 | the `nm-devices` network type. The example below is an OpenVPN client |
4956 | 121 | client connection, which is not supported by Netplan at the moment. | 115 | connection, which is not supported by Netplan at the moment. |
4957 | 122 | 116 | ||
4958 | 123 | ```yaml | 117 | ```yaml |
4959 | 124 | network: | 118 | network: |
4960 | diff --git a/doc/netplan-yaml.md b/doc/netplan-yaml.md | |||
4961 | index 11e7c41..23513c8 100644 | |||
4962 | --- a/doc/netplan-yaml.md | |||
4963 | +++ b/doc/netplan-yaml.md | |||
4964 | @@ -850,8 +850,9 @@ interfaces, as well as individual wifi networks, by means of the `auth` block. | |||
4965 | 850 | 850 | ||
4966 | 851 | > The supported key management modes are `none` (no key management); | 851 | > The supported key management modes are `none` (no key management); |
4967 | 852 | > `psk` (WPA with pre-shared key, common for home wifi); `eap` (WPA | 852 | > `psk` (WPA with pre-shared key, common for home wifi); `eap` (WPA |
4970 | 853 | > with EAP, common for enterprise wifi); `sae` (used by WPA3); and `802.1x` | 853 | > with EAP, common for enterprise wifi); `eap-sha256` (used with WPA3-Enterprise); |
4971 | 854 | > (used primarily for wired Ethernet connections). | 854 | > `eap-suite-b-192` (used with WPA3-Enterprise); `sae` (used by WPA3); |
4972 | 855 | > and `802.1x` (used primarily for wired Ethernet connections). | ||
4973 | 855 | 856 | ||
4974 | 856 | - **password** (scalar) | 857 | - **password** (scalar) |
4975 | 857 | 858 | ||
4976 | @@ -863,7 +864,8 @@ interfaces, as well as individual wifi networks, by means of the `auth` block. | |||
4977 | 863 | - **method** (scalar) | 864 | - **method** (scalar) |
4978 | 864 | 865 | ||
4979 | 865 | > The EAP method to use. The supported EAP methods are `tls` (TLS), | 866 | > The EAP method to use. The supported EAP methods are `tls` (TLS), |
4981 | 866 | > `peap` (Protected EAP), and `ttls` (Tunneled TLS). | 867 | > `peap` (Protected EAP), `leap` (Lightweight EAP), `pwd` (EAP Password) |
4982 | 868 | > and `ttls` (Tunneled TLS). | ||
4983 | 867 | 869 | ||
4984 | 868 | - **identity** (scalar) | 870 | - **identity** (scalar) |
4985 | 869 | 871 | ||
4986 | diff --git a/doc/reference.md b/doc/reference.md | |||
4987 | index fe049d5..bf11582 100644 | |||
4988 | --- a/doc/reference.md | |||
4989 | +++ b/doc/reference.md | |||
4990 | @@ -20,8 +20,8 @@ maxdepth: 1 | |||
4991 | 20 | netplan-yaml | 20 | netplan-yaml |
4992 | 21 | ``` | 21 | ``` |
4993 | 22 | 22 | ||
4996 | 23 | ## API specification | 23 | ## libnetplan API |
4997 | 24 | `libnetplan` is a component of the Netplan. project that contains the logic for | 24 | `libnetplan` is a component of the Netplan project that contains the logic for |
4998 | 25 | data parsing, validation and generation. It is build as a dynamic `.so` library | 25 | data parsing, validation and generation. It is build as a dynamic `.so` library |
4999 | 26 | that can be used from different binaries (like Netplan’s `generate`, | 26 | that can be used from different binaries (like Netplan’s `generate`, |
5000 | 27 | `netplan-dbus`, the `netplan apply/try/get/set/...` CLI or via the corresponding | 27 | `netplan-dbus`, the `netplan apply/try/get/set/...` CLI or via the corresponding |
The diff has been truncated for viewing.
* rm .pyc/__pycache__ in python3- netplan. preinst? => Do we want/need this in Noble, too? (Can you create a Salsa MR against debian/unstable?) patches/ 0002-ovs- disable- StartLimitBurst -in-the- ovs-cleanup- servi.patch, too. IMO 3ubuntu0. 23.10.1 version string is (currently) bigger than what we have in noble-release, but this will be resolved by 1.0-1 in noble-proposed (stuck due to armhf time_t)
* d/control: We might want to keep the openvswitch-switch <!nocheck> build-depends on armhf, as it's still built on Mantic
=> This would allow getting rid of debian/
=> non-blocking: As the OVS autopkgtests are skipped on armhf, too, due to missing kernel module in the container
* note (non-blocking): The 0.107.1-
=> We should probably keep this version string as-is
LGTM! I'm just slightly concerned about the first bullet point and a little bit about the 2nd (for not reducing OVS test coverage on armhf)