[settings] Clarify usage of the term "named setting"

There are currently two conflicting usages of the term "named setting"
within iPXE: one refers to predefined settings (such as show up in the
"config" UI), the other refers to settings identified by a name (such
as "net0.dhcp/ip").

Split these usages into the term "predefined setting" and "named
setting" to avoid ambiguity.

Signed-off-by: Michael Brown <mcb30@ipxe.org>

diff --git a/src/arch/i386/interface/vmware/guestinfo.c b/src/arch/i386/interface/vmware/guestinfo.c
index da013ca28f2bc249d57970c6f1105641f69f6611..8ce363aafe818afeab52d61766fcbf6c4461ca5f 100644 (file)
--- a/src/arch/i386/interface/vmware/guestinfo.c
+++ b/src/arch/i386/interface/vmware/guestinfo.c
@@ -58,7 +58,7 @@ static int guestinfo_fetch_type ( struct settings *settings,
                      strlen ( parent_name ) + 1 /* "." */ +
                      strlen ( setting->name ) + 1 /* "." */ +
                      ( type ? strlen ( type->name ) : 0 ) + 1 /* NUL */ ];
-       struct setting *named_setting;
+       struct setting *predefined;
        char *info;
        int info_len;
        int check_len;
@@ -82,9 +82,8 @@ static int guestinfo_fetch_type ( struct settings *settings,
 
        /* Determine default type if necessary */
        if ( ! type ) {
-               named_setting = find_setting ( setting->name );
-               type = ( named_setting ?
-                        named_setting->type : &setting_type_string );
+               predefined = find_setting ( setting->name );
+               type = ( predefined ? predefined->type : &setting_type_string );
        }
        assert ( type != NULL );
 

diff --git a/src/core/settings.c b/src/core/settings.c
index 8cdabe098fbf59ebf0b6f50be4fa7eb54381f7e6..6d0c854f5f710a97ef9761f62a5d3b9e9b7d4de0 100644 (file)
--- a/src/core/settings.c
+++ b/src/core/settings.c
@@ -262,7 +262,7 @@ static void autovivified_settings_free ( struct refcnt *refcnt ) {
 }
 
 /**
- * Find child named settings block
+ * Find child settings block
  *
  * @v parent           Parent settings block
  * @v name             Name within this parent
@@ -289,7 +289,7 @@ struct settings * find_child_settings ( struct settings *parent,
 }
 
 /**
- * Find or create child named settings block
+ * Find or create child settings block
  *
  * @v parent           Parent settings block
  * @v name             Name within this parent
@@ -383,7 +383,7 @@ parse_settings_name ( const char *name,
 }
 
 /**
- * Find named settings block
+ * Find settings block
  *
  * @v name             Name
  * @ret settings       Settings block, or NULL
@@ -1113,10 +1113,10 @@ int storef_setting ( struct settings *settings, struct setting *setting,
  */
 
 /**
- * Find named setting
+ * Find predefined setting
  *
  * @v name             Name
- * @ret setting                Named setting, or NULL
+ * @ret setting                Setting, or NULL
  */
 struct setting * find_setting ( const char *name ) {
        struct setting *setting;
@@ -1192,7 +1192,7 @@ parse_setting_name ( const char *name,
        char *settings_name;
        char *setting_name;
        char *type_name;
-       struct setting *named_setting;
+       struct setting *predefined;
 
        /* Set defaults */
        *settings = &settings_root;
@@ -1226,10 +1226,10 @@ parse_setting_name ( const char *name,
        setting->tag = parse_setting_tag ( setting_name );
        setting->scope = (*settings)->default_scope;
        setting->name = setting_name;
-       for_each_table_entry ( named_setting, SETTINGS ) {
-               /* Matches a defined named setting; use that setting */
-               if ( setting_cmp ( named_setting, setting ) == 0 ) {
-                       memcpy ( setting, named_setting, sizeof ( *setting ) );
+       for_each_table_entry ( predefined, SETTINGS ) {
+               /* Matches a predefined setting; use that setting */
+               if ( setting_cmp ( predefined, setting ) == 0 ) {
+                       memcpy ( setting, predefined, sizeof ( *setting ) );
                        break;
                }
        }

diff --git a/src/interface/smbios/smbios_settings.c b/src/interface/smbios/smbios_settings.c
index d2975df442a716d965339e56f5b1f01d7e69a9f4..ecd3f1d9732509e2c6c372315b6cc445be5d52d8 100644 (file)
--- a/src/interface/smbios/smbios_settings.c
+++ b/src/interface/smbios/smbios_settings.c
@@ -197,8 +197,8 @@ struct setting uuid_setting __setting ( SETTING_HOST ) = {
        .scope = &smbios_settings_scope,
 };
 
-/** Other SMBIOS named settings */
-struct setting smbios_named_settings[] __setting ( SETTING_HOST_EXTRA ) = {
+/** Other SMBIOS predefined settings */
+struct setting smbios_predefined_settings[] __setting ( SETTING_HOST_EXTRA ) = {
        {
                .name = "manufacturer",
                .description = "Manufacturer",

diff --git a/src/net/netdev_settings.c b/src/net/netdev_settings.c
index 72152762cd46a0694f4d15c1ec6744ea7fad72fd..52e8007dd0d73c4fc4103a71525d8b1438b06166 100644 (file)
--- a/src/net/netdev_settings.c
+++ b/src/net/netdev_settings.c
@@ -35,7 +35,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
  *
  */
 
-/** Network device named settings */
+/** Network device predefined settings */
 struct setting mac_setting __setting ( SETTING_NETDEV ) = {
        .name = "mac",
        .description = "MAC address",