Add deprecation warning for EMMAKEN_CFLAGS (emscripten-core#15685)

sbc100 · web-flow · commit f95f2cc4383a · 2021-12-03T11:57:37.000-08:00
Also, move processing of EMMAKEN_CFLAGS up to the same place where we process EMCC_FLAGS to its obvious they are equivalent. See emscripten-core#15684
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -20,6 +20,7 @@ See docs/process.md for more on how version tagging works.
 
 3.0.1
 -----
+- Deprecate `EMMAKEN_CFLAGS` is favor of `EMCC_CFLAGS`.
 
 3.0.0 - 11/22/2021
 ------------------
diff --git a/docs/emcc.txt b/docs/emcc.txt
@@ -606,9 +606,11 @@ Environment variables
 
 *emcc* is affected by several environment variables, as listed below:
 
-   * "EMMAKEN_CFLAGS" [compile+link]
+   * "EMMAKEN_CFLAGS" [compile+link] Deprecated. Use "EMCC_CFLAGS"
+     instead.
 
-   * "EMMAKEN_COMPILER" [compile+link] Deprecated. Avoid using.
+   * "EMMAKEN_COMPILER" [compile+link] Deprecated. Use "EM_LLVM_ROOT"
+     and/or "EM_COMPIELR_WRAPPER" instead.
 
    * "EMMAKEN_JUST_CONFIGURE" [other]
 
diff --git a/emcc.py b/emcc.py
@@ -964,13 +964,14 @@ def run(args):
   # Additional compiler flags that we treat as if they were passed to us on the
   # commandline
   EMCC_CFLAGS = os.environ.get('EMCC_CFLAGS')
-  if DEBUG:
-    cmd = shared.shlex_join(args)
-    if EMCC_CFLAGS:
-      cmd += ' + ' + EMCC_CFLAGS
-    logger.warning(f'invocation: {cmd} (in {os.getcwd()})')
   if EMCC_CFLAGS:
     args.extend(shlex.split(EMCC_CFLAGS))
+  EMMAKEN_CFLAGS = os.environ.get('EMMAKEN_CFLAGS')
+  if EMMAKEN_CFLAGS:
+    args += shlex.split(EMMAKEN_CFLAGS)
+
+  if DEBUG:
+    logger.warning(f'invocation: {shared.shlex_join(args)} (in {os.getcwd()})')
 
   # Strip args[0] (program name)
   args = args[1:]
@@ -1003,7 +1004,6 @@ def run(args):
     return 0
 
   if '--version' in args:
-
     print(version_string())
     print('''\
 Copyright (C) 2014 the Emscripten authors (see AUTHORS.txt)
@@ -1051,16 +1051,15 @@ def run(args):
   if '-print-search-dirs' in args:
     return run_process([clang, '-print-search-dirs'], check=False).returncode
 
-  EMMAKEN_CFLAGS = os.environ.get('EMMAKEN_CFLAGS')
-  if EMMAKEN_CFLAGS:
-    args += shlex.split(EMMAKEN_CFLAGS)
+  ## Process argument and setup the compiler
+  state = EmccState(args)
+  options, newargs, settings_map = phase_parse_arguments(state)
 
   if 'EMMAKEN_NO_SDK' in os.environ:
     diagnostics.warning('deprecated', 'We hope to deprecated EMMAKEN_NO_SDK.  See https://github.com/emscripten-core/emscripten/issues/14050 if use use this feature.')
 
-  ## Process argument and setup the compiler
-  state = EmccState(args)
-  options, newargs, settings_map = phase_parse_arguments(state)
+  if 'EMMAKEN_CFLAGS' in os.environ:
+    diagnostics.warning('deprecated', '`EMMAKEN_CFLAGS` is deprecated, please use `EMCC_CFLAGS` instead.  See https://github.com/emscripten-core/emscripten/issues/15684')
 
   # For internal consistency, ensure we don't attempt or read or write any link time
   # settings until we reach the linking phase.
diff --git a/site/source/docs/tools_reference/emcc.rst b/site/source/docs/tools_reference/emcc.rst
@@ -524,8 +524,8 @@ Environment variables
 =====================
 *emcc* is affected by several environment variables, as listed below:
 
-  - ``EMMAKEN_CFLAGS`` [compile+link]
-  - ``EMMAKEN_COMPILER`` [compile+link] Deprecated. Avoid using.
+  - ``EMMAKEN_CFLAGS`` [compile+link] Deprecated. Use ``EMCC_CFLAGS`` instead.
+  - ``EMMAKEN_COMPILER`` [compile+link] Deprecated. Use ``EM_LLVM_ROOT`` and/or ``EM_COMPIELR_WRAPPER`` instead.
   - ``EMMAKEN_JUST_CONFIGURE`` [other]
   - ``EMCC_AUTODEBUG`` [compile+link]
   - ``EMCC_CFLAGS`` [compile+link]
diff --git a/tests/test_core.py b/tests/test_core.py
@@ -6394,7 +6394,7 @@ def do_test():
       # In ASan mode we need a large initial memory (or else wasm-ld fails).
       # The OpenJPEG CMake will build several executables (which we need parts
       # of in our testing, see above), so we must enable the flag for them all.
-      with env_modify({'EMMAKEN_CFLAGS': '-sINITIAL_MEMORY=300MB'}):
+      with env_modify({'EMCC_CFLAGS': '-sINITIAL_MEMORY=300MB'}):
         do_test_openjpeg()
     else:
       do_test_openjpeg()
diff --git a/tests/test_other.py b/tests/test_other.py
@@ -10348,6 +10348,11 @@ def test_emmaken_compiler(self):
     stderr = self.run_process([EMCC, '-c', test_file('core/test_hello_world.c')], stderr=PIPE).stderr
     self.assertContained('warning: `EMMAKEN_COMPILER` is deprecated', stderr)
 
+  @with_env_modify({'EMMAKEN_CFLAGS': '-O2'})
+  def test_emmaken_cflags(self):
+    stderr = self.run_process([EMCC, '-c', test_file('core/test_hello_world.c')], stderr=PIPE).stderr
+    self.assertContained('warning: `EMMAKEN_CFLAGS` is deprecated', stderr)
+
   @no_windows('relies on a shell script')
   def test_compiler_wrapper(self):
     create_file('wrapper.sh', '''\
@@ -10624,10 +10629,10 @@ def test_gen_struct_info(self):
     self.assertFileContents(test_file('reference_struct_info.json'), read_file('out.json'))
 
   def test_gen_struct_info_env(self):
-    # gen_struct_info.py builds C code in a very particlar way.  We don't want EMMAKEN_CFLAGS to
+    # gen_struct_info.py builds C code in a very particlar way.  We don't want EMCC_CFLAGS to
     # be injected which could cause it to fail.
     # For example -O2 causes printf -> iprintf which will fail with undefined symbol iprintf.
-    with env_modify({'EMMAKEN_CFLAGS': '-O2 BAD_ARG'}):
+    with env_modify({'EMCC_CFLAGS': '-O2 BAD_ARG'}):
       self.run_process([PYTHON, path_from_root('tools/gen_struct_info.py'), '-o', 'out.json'])
 
   def test_relocatable_limited_exports(self):
