Rename "src_filter" and "src_build_flags" options // Resolve #4245

HISTORY.rst

@@ -52,7 +52,7 @@ Please check `Migration guide from 5.x to 6.0 <https://docs.platformio.org/en/la
   - Generate reports in JUnit and JSON formats using the `pio test --output-format <https://docs.platformio.org/en/latest/core/userguide/cmd_test.html#cmdoption-pio-test-output-format>`__ option  (`issue #2891 <https://github.com/platformio/platformio-core/issues/2891>`_)
   - Provide more information when the native program crashed on a host (errored with a negative return code) (`issue #3429 <https://github.com/platformio/platformio-core/issues/3429>`_)
   - Fixed an issue when command line parameters (``--ignore``, ``--filter``) do not override values defined in the |PIOCONF| (`issue #3845 <https://github.com/platformio/platformio-core/issues/3845>`_)
-  - Renamed the "test_build_project_src" project configuration option to `test_build_src <https://docs.platformio.org/en/latest//projectconf/section_env_test.html#test-build-src>`__
+  - Renamed the "test_build_project_src" project configuration option to the `test_build_src <https://docs.platformio.org/en/latest//projectconf/section_env_test.html#test-build-src>`__
   - Removed the "test_transport" option in favor of the `Custom "unity_config.h" <https://docs.platformio.org/en/latest/advanced/unit-testing/frameworks/unity.html>`_
 
 * **Static Code Analysis**
@@ -82,6 +82,8 @@ Please check `Migration guide from 5.x to 6.0 <https://docs.platformio.org/en/la
 
   - Extended `Interpolation of Values <https://docs.platformio.org/en/latest/projectconf/interpolation.html>`__  with ``${this}`` pattern (`issue #3953 <https://github.com/platformio/platformio-core/issues/3953>`_)
   - Embed environment name of the current section in the |PIOCONF| using ``${this.__env__}`` pattern
+  - Renamed the "src_build_flags" project configuration option to the `build_src_flags <https://docs.platformio.org/en/latest/projectconf/section_env_build.html#build-src-flags>`__
+  - Renamed the "src_filter" project configuration option to the `build_src_filter <https://docs.platformio.org/en/latest/projectconf/section_env_build.html#build-src-filter>`__
 
 * **Miscellaneous**
 

platformio/project/options.py

@@ -419,13 +419,14 @@ def get_default_core_dir():
             ),
             ConfigEnvOption(
                 group="build",
-                name="src_build_flags",
+                name="build_src_flags",
+                oldnames=["src_build_flags"],
                 description=(
                     "The same as `build_flags` but configures flags the only for "
-                    "project source files (`src` folder)"
+                    "project source files in the `src` folder"
                 ),
                 multiple=True,
-                sysenvvar="PLATFORMIO_SRC_BUILD_FLAGS",
+                sysenvvar="PLATFORMIO_BUILD_SRC_FLAGS",
                 buildenvvar="SRC_BUILD_FLAGS",
             ),
             ConfigEnvOption(
@@ -438,13 +439,14 @@ def get_default_core_dir():
             ),
             ConfigEnvOption(
                 group="build",
-                name="src_filter",
+                name="build_src_filter",
+                oldnames=["src_filter"],
                 description=(
-                    "Control which source files should be included/excluded from a "
-                    "build process"
+                    "Control which source files from the `src` folder should "
+                    "be included/excluded from a build process"
                 ),
                 multiple=True,
-                sysenvvar="PLATFORMIO_SRC_FILTER",
+                sysenvvar="PLATFORMIO_BUILD_SRC_FILTER",
                 buildenvvar="SRC_FILTER",
                 default="+<*> -<.git/> -<.svn/>",
             ),