Draco v1.5.4 release. (#934)

.cmake-format.py

@@ -1,102 +1,107 @@
-# Generated with cmake-format 0.5.1
-# How wide to allow formatted cmake files
-line_width = 80
-
-# How many spaces to tab for indent
-tab_size = 2
-
-# If arglists are longer than this, break them always
-max_subargs_per_line = 10
-
-# If true, separate flow control names from their parentheses with a space
-separate_ctrl_name_with_space = False
-
-# If true, separate function names from parentheses with a space
-separate_fn_name_with_space = False
-
-# If a statement is wrapped to more than one line, than dangle the closing
-# parenthesis on its own line
-dangle_parens = False
-
-# What character to use for bulleted lists
-bullet_char = '*'
-
-# What character to use as punctuation after numerals in an enumerated list
-enum_char = '.'
-
-# What style line endings to use in the output.
-line_ending = u'unix'
-
-# Format command names consistently as 'lower' or 'upper' case
-command_case = u'lower'
-
-# Format keywords consistently as 'lower' or 'upper' case
-keyword_case = u'unchanged'
-
-# Specify structure for custom cmake functions
-additional_commands = {
-  "foo": {
-    "flags": [
-      "BAR",
-      "BAZ"
-    ],
-    "kwargs": {
-      "HEADERS": "*",
-      "DEPENDS": "*",
-      "SOURCES": "*"
-    }
+with section('parse'):
+  # Specify structure for custom cmake functions
+  additional_commands = {
+      'draco_add_emscripten_executable': {
+          'kwargs': {
+              'NAME': '*',
+              'SOURCES': '*',
+              'OUTPUT_NAME': '*',
+              'DEFINES': '*',
+              'INCLUDES': '*',
+              'COMPILE_FLAGS': '*',
+              'LINK_FLAGS': '*',
+              'OBJLIB_DEPS': '*',
+              'LIB_DEPS': '*',
+              'GLUE_PATH': '*',
+              'PRE_LINK_JS_SOURCES': '*',
+              'POST_LINK_JS_SOURCES': '*',
+              'FEATURES': '*',
+          },
+          'pargs': 0
+      },
+      'draco_add_executable': {
+          'kwargs': {
+              'NAME': '*',
+              'SOURCES': '*',
+              'OUTPUT_NAME': '*',
+              'TEST': 0,
+              'DEFINES': '*',
+              'INCLUDES': '*',
+              'COMPILE_FLAGS': '*',
+              'LINK_FLAGS': '*',
+              'OBJLIB_DEPS': '*',
+              'LIB_DEPS': '*',
+          },
+          'pargs': 0
+      },
+      'draco_add_library': {
+          'kwargs': {
+              'NAME': '*',
+              'TYPE': '*',
+              'SOURCES': '*',
+              'TEST': 0,
+              'OUTPUT_NAME': '*',
+              'DEFINES': '*',
+              'INCLUDES': '*',
+              'COMPILE_FLAGS': '*',
+              'LINK_FLAGS': '*',
+              'OBJLIB_DEPS': '*',
+              'LIB_DEPS': '*',
+              'PUBLIC_INCLUDES': '*',
+          },
+          'pargs': 0
+      },
+      'draco_generate_emscripten_glue': {
+          'kwargs': {
+              'INPUT_IDL': '*',
+              'OUTPUT_PATH': '*',
+          },
+          'pargs': 0
+      },
+      'draco_get_required_emscripten_flags': {
+          'kwargs': {
+              'FLAG_LIST_VAR_COMPILER': '*',
+              'FLAG_LIST_VAR_LINKER': '*',
+          },
+          'pargs': 0
+      },
+      'draco_option': {
+          'kwargs': {
+              'NAME': '*',
+              'HELPSTRING': '*',
+              'VALUE': '*',
+          },
+          'pargs': 0
+      },
   }
-}
-
-# A list of command names which should always be wrapped
-always_wrap = []
-
-# Specify the order of wrapping algorithms during successive reflow attempts
-algorithm_order = [0, 1, 2, 3, 4]
-
-# If true, the argument lists which are known to be sortable will be sorted
-# lexicographicall
-autosort = False
-
-# enable comment markup parsing and reflow
-enable_markup = True
 
-# If comment markup is enabled, don't reflow the first comment block in
-# eachlistfile. Use this to preserve formatting of your
-# copyright/licensestatements.
-first_comment_is_literal = True
+with section('format'):
+  # Formatting options.
 
-# If comment markup is enabled, don't reflow any comment block which matchesthis
-# (regex) pattern. Default is `None` (disabled).
-literal_comment_pattern = None
+  # How wide to allow formatted cmake files
+  line_width = 80
 
-# Regular expression to match preformat fences in comments
-# default=r'^\s*([`~]{3}[`~]*)(.*)$'
-fence_pattern = u'^\\s*([`~]{3}[`~]*)(.*)$'
+  # How many spaces to tab for indent
+  tab_size = 2
 
-# Regular expression to match rulers in comments
-# default=r'^\s*[^\w\s]{3}.*[^\w\s]{3}$'
-ruler_pattern = u'^\\s*[^\\w\\s]{3}.*[^\\w\\s]{3}$'
+  # If true, separate flow control names from their parentheses with a space
+  separate_ctrl_name_with_space = False
 
-# If true, emit the unicode byte-order mark (BOM) at the start of the file
-emit_byteorder_mark = False
+  # If true, separate function names from parentheses with a space
+  separate_fn_name_with_space = False
 
-# If a comment line starts with at least this many consecutive hash characters,
-# then don't lstrip() them off. This allows for lazy hash rulers where the first
-# hash char is not separated by space
-hashruler_min_length = 10
+  # If a statement is wrapped to more than one line, than dangle the closing
+  # parenthesis on its own line.
+  dangle_parens = False
 
-# If true, then insert a space between the first hash char and remaining hash
-# chars in a hash ruler, and normalize its length to fill the column
-canonicalize_hashrulers = True
+  # Do not sort argument lists.
+  enable_sort = False
 
-# Specify the encoding of the input file. Defaults to utf-8.
-input_encoding = u'utf-8'
+  # What style line endings to use in the output.
+  line_ending = 'unix'
 
-# Specify the encoding of the output file. Defaults to utf-8. Note that cmake
-# only claims to support utf-8 so be careful when using anything else
-output_encoding = u'utf-8'
+  # Format command names consistently as 'lower' or 'upper' case
+  command_case = 'canonical'
 
-# A dictionary containing any per-command configuration overrides. Currently
-# only `command_case` is supported.
-per_command = {}
+  # Format keywords consistently as 'lower' or 'upper' case
+  keyword_case = 'upper'

.gitattributes

@@ -1 +1 @@
-*.obj eol=lf
+*.obj eol=lf

BUILDING.md

@@ -77,6 +77,15 @@ CMake Build Configuration
 Transcoder
 ----------
 
+Before attempting to build Draco with transcoding support you must run an
+additional Git command to obtain the submodules:
+
+~~~~~ bash
+# Run this command from within your Draco clone.
+$ git submodule update --init
+# See below if you prefer to use existing versions of Draco dependencies.
+~~~~~
+
 In order to build the `draco_transcoder` target, the transcoding support needs
 to be explicitly enabled when you run `cmake`, for example:
 
@@ -90,7 +99,7 @@ built with the transcoder support may result in increased binary sizes of the
 produced libraries and executables compared to the default CMake settings.
 
 The following CMake variables can be used to configure Draco to use local
-copies of third party dependencies.
+copies of third party dependencies instead of git submodules.
 
 - `DRACO_EIGEN_PATH`: this path must contain an Eigen directory that includes
   the Eigen sources.
@@ -99,7 +108,7 @@ copies of third party dependencies.
 - `DRACO_TINYGLTF_PATH`: this path must contain tiny_gltf.h and its
   dependencies.
 
-If not specified the Draco build requires the presence of the submodules that
+When not specified the Draco build requires the presence of the submodules that
 are stored within `draco/third_party`.
 
 Debugging and Optimization