layers: Clean up layer settings file comments.

Normalize and clean up internal documentation for the
vk_layer_settings.txt file.
No logic or behavior changes.

Change-Id: Iceb45efb50bcb670b099027980244cc1e2358643

diff --git a/layers/vk_layer_settings.txt b/layers/vk_layer_settings.txt
index 3674035..f5dcb5f 100644 (file)
--- a/layers/vk_layer_settings.txt
+++ b/layers/vk_layer_settings.txt
@@ -1,59 +1,57 @@
-# This is an example vk_layer_settings.txt file.
+################################################################################
 #
-#  This file allows for per-layer settings which can dynamically affect layer
-#  behavior. Comments in this file are denoted with the "#" char.
-#  Settings lines are of the form "<LayerIdentifier>.<SettingName> = <SettingValue>"
+#  This file contains per-layer settings that configure layer behavior at
+#  execution time. Comments in this file are denoted with the "#" char.
+#  Settings lines are of the form:
+#      "<LayerIdentifier>.<SettingName> = <SettingValue>"
 #
-#  <LayerIdentifier> is typically the official layer name, minus the VK_LAYER prefix
-#  and all lower-camel-case -- i.e., for VK_LAYER_LUNARG_core_validation, the layer
-#  identifier is 'lunarg_core_validation', and for VK_LAYER_GOOGLE_threading the layer
-#  identifier is 'google_threading'.
+#  <LayerIdentifier> is typically the official layer name, minus the VK_LAYER
+#  prefix and all lower-camel-case -- i.e., for VK_LAYER_LUNARG_core_validation,
+#  the layer identifier is 'lunarg_core_validation', and for
+#  VK_LAYER_GOOGLE_threading the layeridentifier is 'google_threading'.
 #
-#  There are some common settings that are used by each layer.
-#  Below is a general description of three common settings, followed by
-#  actual template settings for each layer in the SDK.
-#
-# Common settings descriptions:
-# =============================
+################################################################################
+################################################################################
+# Validation Layer Common Settings:
+# =================================
 #
 #   DEBUG_ACTION:
 #   =============
-#   <LayerIdentifier>.debug_action : This is an enum value indicating what action is to
-#    be taken when a layer wants to report information. Possible settings values
-#    are defined in the vk_layer.h header file. These settings are:
-#    VK_DBG_LAYER_ACTION_IGNORE - Take no action
-#    VK_DBG_LAYER_ACTION_LOG_MSG - Log a txt message to stdout or to a log file
-#       specified via the <LayerIdentifier>.log_filename setting (see below)
+#   <LayerIdentifier>.debug_action : This is an enum value indicating what
+#    action is to be taken when a layer wants to report information.
+#    Possible settings values are defined in the vk_layer.h header file.
+#    These settings are:
+#    VK_DBG_LAYER_ACTION_IGNORE - Take no action.
+#    VK_DBG_LAYER_ACTION_LOG_MSG - Log a txt message to stdout or to a log filename
+#       specified via the <LayerIdentifier>.log_filename setting (see below).
 #    VK_DBG_LAYER_ACTION_CALLBACK - Call user defined callback function(s) that
 #       have been registered via the VK_EXT_debug_report extension. Since
 #       app must register callback, this is a NOOP for the settings file.
-#    VK_DBG_LAYER_DEBUG_OUTPUT [Windows only] - Log a txt message using the Windows
-#       OutputDebugString function -- messages will show up in Visual Studio output
-#       window, for instance.
+#    VK_DBG_LAYER_DEBUG_OUTPUT [Windows only] - Log a txt message using the
+#       Windows OutputDebugString function -- messages will show up in the
+#       Visual Studio output window, for instance.
 #    VK_DBG_LAYER_ACTION_BREAK - Trigger a breakpoint.
 #
 #   REPORT_FLAGS:
 #   =============
-#   <LayerIdentifier>.report_flags : This is a comma-delineated list of options telling
-#    the layer what types of messages it should report back. Options are:
-#    info - Report informational messages
-#    warn - Report warnings from using the API in a manner which may lead to undefined
-#           behavior or to warn the user of common trouble spots. A warning does NOT
-#           necessarily signify illegal application behavior.
-#    perf - Report using the API in a way that may cause suboptimal performance
-#    error - Report errors in API usage
-#    debug - For layer development. Report messages for debugging layer behavior
+#   <LayerIdentifier>.report_flags : This is a comma-delineated list of options
+#    telling the layer what types of messages it should report back.
+#    Options are:
+#    info - Report informational messages.
+#    warn - Report warnings from using the API in a manner which may lead to
+#           undefined behavior or to warn the user of common trouble spots.
+#           A warning does NOT necessarily signify illegal application behavior.
+#    perf - Report using the API in a way that may cause suboptimal performance.
+#    error - Report errors in API usage.
+#    debug - For layer development. Report messages for debugging layer
+#            behavior.
 #
 #   LOG_FILENAME:
 #   =============
-#   <LayerIdentifier>.log_filename : output filename. Can be relative to location of
-#      vk_layer_settings.txt file, or an absolute path. If no filename is
-#      specified or if filename has invalid path, then stdout is used by default.
-#
-#
-#
-# Example of actual settings for each layer:
-# ==========================================
+#   <LayerIdentifier>.log_filename : output filename. Can be relative to
+#      location of vk_layer_settings.txt file, or an absolute path. If no
+#      filename is specified or if filename has invalid path, then stdout
+#      is used by default.
 #
 
 # VK_LAYER_LUNARG_core_validation Settings
@@ -90,3 +88,4 @@ google_threading.log_filename = stdout
 google_unique_objects.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
 google_unique_objects.report_flags = error,warn,perf
 google_unique_objects.log_filename = stdout
+################################################################################