mirror of
https://gitlab.nic.cz/labs/bird.git
synced 2024-12-22 09:41:54 +00:00
Moved parser docs to cf-lex.l, so that the parser compiles.
This commit is contained in:
parent
cdb898cfd4
commit
58f9453776
1
conf/Doc
1
conf/Doc
@ -1,4 +1,3 @@
|
|||||||
H Configuration
|
H Configuration
|
||||||
S conf.c
|
S conf.c
|
||||||
S cf-lex.l
|
S cf-lex.l
|
||||||
S confbase.Y
|
|
||||||
|
@ -424,3 +424,35 @@ cf_symbol_class_name(struct symbol *sym)
|
|||||||
return "unknown type";
|
return "unknown type";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DOC: Parser
|
||||||
|
*
|
||||||
|
* Both the configuration and CLI commands are analysed using a syntax
|
||||||
|
* driven parser generated by the |bison| tool from a grammar which
|
||||||
|
* is constructed from information gathered from grammar snippets by
|
||||||
|
* the |gen_parser.m4| script.
|
||||||
|
*
|
||||||
|
* Grammar snippets are files (usually with extension |.Y|) contributed
|
||||||
|
* by various BIRD modules to provide information about syntax of their
|
||||||
|
* configuration and their CLI commands. Each snipped consists of several
|
||||||
|
* section, each of them starting with a special keyword: |CF_HDR| for
|
||||||
|
* a list of |#include| directives needed by the C code, |CF_DEFINES|
|
||||||
|
* for a list of C declarations, |CF_DECLS| for |bison| declarations
|
||||||
|
* including keyword definitions specified as |CF_KEYWORDS|, |CF_GRAMMAR|
|
||||||
|
* for the grammar rules, |CF_CODE| for auxillary C code and finally
|
||||||
|
* |CF_END| at the end of the snippet.
|
||||||
|
*
|
||||||
|
* To create references between the snippets, it's possible to define
|
||||||
|
* multi-part rules by utilizing the |CF_ADDTO| macro which adds a new
|
||||||
|
* alternative to a multi-part rule.
|
||||||
|
*
|
||||||
|
* CLI commands are defined using a |CF_CLI| macro. Its parameters are:
|
||||||
|
* the list of keywords determining the command, the list of paramaters,
|
||||||
|
* help text for the parameters and help text for the command.
|
||||||
|
*
|
||||||
|
* Values of |enum| filter types can be defined using |CF_ENUM| with
|
||||||
|
* the following parameters: name of filter type, prefix common for all
|
||||||
|
* literals of this type, names of all the possible values.
|
||||||
|
*/
|
||||||
|
@ -6,37 +6,6 @@
|
|||||||
* Can be freely distributed and used under the terms of the GNU GPL.
|
* Can be freely distributed and used under the terms of the GNU GPL.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
|
||||||
* DOC: Parser
|
|
||||||
*
|
|
||||||
* Both the configuration and CLI commands are analysed using a syntax
|
|
||||||
* driven parser generated by the |bison| tool from a grammar which
|
|
||||||
* is constructed from information gathered from grammar snippets by
|
|
||||||
* the |gen_parser.m4| script.
|
|
||||||
*
|
|
||||||
* Grammar snippets are files (usually with extension |.Y|) contributed
|
|
||||||
* by various BIRD modules to provide information about syntax of their
|
|
||||||
* configuration and their CLI commands. Each snipped consists of several
|
|
||||||
* section, each of them starting with a special keyword: |CF_HDR| for
|
|
||||||
* a list of |#include| directives needed by the C code, |CF_DEFINES|
|
|
||||||
* for a list of C declarations, |CF_DECLS| for |bison| declarations
|
|
||||||
* including keyword definitions specified as |CF_KEYWORDS|, |CF_GRAMMAR|
|
|
||||||
* for the grammar rules, |CF_CODE| for auxillary C code and finally
|
|
||||||
* |CF_END| at the end of the snippet.
|
|
||||||
*
|
|
||||||
* To create references between the snippets, it's possible to define
|
|
||||||
* multi-part rules by utilizing the |CF_ADDTO| macro which adds a new
|
|
||||||
* alternative to a multi-part rule.
|
|
||||||
*
|
|
||||||
* CLI commands are defined using a |CF_CLI| macro. Its parameters are:
|
|
||||||
* the list of keywords determining the command, the list of paramaters,
|
|
||||||
* help text for the parameters and help text for the command.
|
|
||||||
*
|
|
||||||
* Values of |enum| filter types can be defined using |CF_ENUM| with
|
|
||||||
* the following parameters: name of filter type, prefix common for all
|
|
||||||
* literals of this type, names of all the possible values.
|
|
||||||
*/
|
|
||||||
|
|
||||||
CF_HDR
|
CF_HDR
|
||||||
|
|
||||||
#include "nest/bird.h"
|
#include "nest/bird.h"
|
||||||
|
Loading…
Reference in New Issue
Block a user