diff --git a/docs/api/generate-settings-spec.c b/docs/api/generate-settings-spec.c index 9fdc316783..9c15314fd2 100644 --- a/docs/api/generate-settings-spec.c +++ b/docs/api/generate-settings-spec.c @@ -124,6 +124,7 @@ write_one_setting (FILE *f, SettingNewFunc func) char *default_value; TypeNameElement *name_iter; GValue value = { 0, }; + char *flags_str = NULL; value_type = g_type_name (G_PARAM_SPEC_VALUE_TYPE (*iter)); for (name_iter = &name_map[0]; name_iter && name_iter->gvalue_name; name_iter++) { @@ -150,15 +151,23 @@ write_one_setting (FILE *f, SettingNewFunc func) g_object_get (G_OBJECT (s), NM_SETTING_NAME, &default_value, NULL); } + if (g_str_has_suffix (key_name, "-flags")) + flags_str = g_strdup_printf (" (see for flag values)"); + (void) fprintf (f, " \n" " %s\n" " %s\n" " %s\n" - " %s\n" + " %s%s\n" " \n", - key_name, value_type, default_value ? default_value : "", value_desc); + key_name, + value_type, + default_value ? default_value : "", + value_desc, + flags_str ? flags_str : ""); + g_free (flags_str); g_free (default_value); } @@ -202,7 +211,7 @@ main (int argc, char *argv[]) "" "]>" "
\n" - " NetworkManager " PACKAGE_VERSION " Settings Specification\n" + " Configuration Settings\n" " \n"); for (fptr = funcs; fptr && *fptr; fptr++) diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml index 0099f54cb8..7e121cc6d3 100644 --- a/docs/api/network-manager-docs.xml +++ b/docs/api/network-manager-docs.xml @@ -55,28 +55,61 @@ - + D-Bus API Reference - - - This part documents the D-Bus interface used to access the - NetworkManager daemon. - - + + This part documents the D-Bus interface used to access the + NetworkManager daemon. + - + - + Network Configuration Setting Specification - - - This part documents the properties and value types of each "Setting" - object that composes the basic unit of NetworkManager configuration, - the "Connection". - - + + This part documents the properties and value types of each "Setting" + object that composes the basic unit of NetworkManager configuration, + the "Connection". Each Connection object is simply a dictionare mapping + setting names (like "wimax" or "bluetooth") to a dictionary of + key/value pairs that represents each itself. + - +
+ Secret flag types + + Each secret property in a setting has an associated "flags" property + that describes how to handle that secret. The "flags" property is a + bitfield that contains zero or more of the following values logically + OR-ed together. + + + + + 0x0 (none) - the system is responsible for providing + and storing this secret. + + + 0x1 (agent-owned) - a user-session secret agent + is responsible for providing and storing this secret; when it is + required, agents will be asked to provide it. + + + 0x2 (not-saved) - this secret should not be saved + but should be requested from the user each time it is required. This + flag should be used for One-Time-Pad secrets, PIN codes from + hardware tokens, or if the user simply does not want to save the + secret. + + + 0x4 (not-required) - in some situations it cannot + be automatically determined that a secret is required or not. This + flag hints that the secret is not required and should not be + requested from the user. + + + +
+ Index