colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

trivial: improve code comments

Browse Source
This commit is contained in:
Thomas Haller
2021-05-26 12:07:11 +02:00
parent 174f7bd27b
commit 8ba66f8ec9
2 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/libnm-core-impl/nm-setting-ip-config.c
View File

@@ -3291,8 +3291,10 @@ nm_ip_routing_rule_from_string(const char * str,
if (!_rr_string_validate(TRUE, to_string_flags, extra_args, error))
return NULL;
/* NM_IP_ROUTING_RULE_TO_STRING_TYPE_IPROUTE gives a string representation that is
* partly compatibly with iproute2. That is, the part after `ip -[46] rule add $ARGS`.
/* nm_ip_routing_rule_from_string() / nm_ip_routing_rule_to_string() has a string representation
* for rules that is partly compatibly with iproute2. That is, the part after
* `ip -[46] rule add $ARGS`.
*
* There are differences though:
*
* - trying to convert an invalid rule to string may not be possible. The reason is for
@@ -3301,9 +3303,9 @@ nm_ip_routing_rule_from_string(const char * str,
* rule to string, the operation may fail or the result may itself not be parsable.
* Of course, valid rules can be converted to string and read back the same (round-trip).
*
* - iproute2 in may regards is flexible about the command lines. For example
* - iproute2 in many regards is flexible about the command lines. For example
* - for tables it accepts table names from /etc/iproute2/rt_tables. We only
* accept the special aliases "main", "local", and "default".
* accept numeric values and the special aliases "main", "local", and "default".
* - key names like "preference" can be abbreviated to "pref", we don't do that.
* - the "preference"/"priority" may be unspecified, in which kernel automatically
* chooses an unused priority (during `ip rule add`). We don't allow for that, the
@@ -3316,11 +3318,10 @@ nm_ip_routing_rule_from_string(const char * str,
* It also supports backslash escaping (e.g. to contain whitespace), but it does
* not support special escape sequences. Values are taken literally, meaning
* "\n\ \111" gives results in "n 111".
* The strings really shouldn't contain any special characters that require escaping,
* but that's the rule.
* This also goes together with the @allow_escaping parameter of nm_utils_strsplit_set().
* The strings really shouldn't contain any special characters that require escaping.
* This also goes together with nm_utils_escaped_tokens_split().
* If you concatenate multiple rule expressions with a delimiter, the delimiter inside
* each word can be backslash escaped, and nm_utils_strsplit_set(allow_escaping=TRUE) will
* each word can be backslash escaped, and nm_utils_escaped_tokens_split() will
* properly split the words, preserving the backslashes, which then will be removed by
* nm_ip_routing_rule_from_string().
*/

4
src/libnm-glib-aux/nm-shared-utils.h
View File

@@ -663,7 +663,7 @@ typedef enum {
* escape characters that
* - precede a delimiter.
* - precede a backslash.
* - preceed a whitespace (with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP).
* - precede a whitespace (only with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP).
*
* Note that with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP, it is only
* necessary to escape the very last whitespace (if the delimiters
@@ -675,7 +675,7 @@ typedef enum {
*
* - "\\$DELIMITER" (escaped delimiter)
* - "\\\\" (escaped backslash)
* - "\\$SPACE" (escaped space) (with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP).
* - "\\$SPACE" (escaped space) (only with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP).
*
* Note that all other escapes like "\\n" or "\\001" are left alone.
* That makes the escaping/unescaping rules simple. Also, for the most part