tools-exporters! - Clean exports with git #2692

theotherjimmy · 2016-09-13T15:33:31Z

Note: This is a proposal with a bit of code.

So the idea is to clean the files that are generated by an export with
the git clean command. This has a benefit for the UX: it tells you when
it removes something. In this way, you know that the clean flag worked,
and you will know immediately if it did something wrong.

An example export with a clean from within mbed-os-example-blinky after
a previous export (or two):

$ mbed export -c -i gcc_arm -m K64F
Removing Makefile
Removing mbed-os-example-blinky.uvopt
Removing mbed-os-example-blinky.uvproj
Removing mbed_config.h
Build Options: debug-info
Scan: .
Scan: FEATURE_COMMON_PAL
Scan: FEATURE_UVISOR
Scan: FEATURE_BLE
Scan: FEATURE_CLIENT
Scan: FEATURE_IPV6
Scan: FEATURE_IPV4
Scan: FEATURE_STORAGE

theotherjimmy · 2016-09-13T15:34:28Z

~~Hmmmmm. need to rebase, seems this contains the toolchain-polymorphic stuff too.~~ Done

It was possible to remove an entire project if clean was specified on the command line. That's a Bad Thing(tm).

Also tells you what it's removing

theotherjimmy · 2016-09-13T15:36:09Z

@0xc0170 @screamerbg @sarahmarshy Could you take a look?

bridadan · 2016-09-13T16:04:25Z

One thing worth noting here: the tools in the mbed-os repository (to my knowledge) have never had an explicit dependency on SCM tools. It was aware of them, but it never actually invoked them directly.

I don't necessarily have a problem with how this is implemented. I would prefer not to add a dependency on git, but it's hard to deny that this implementation is very clean and easy to understand.

I just wanted to bring the addition of the dependency up to just keep things clear. I would say I'd give a solid +0.5 for that reason 😄

sarahmarshy · 2016-09-13T16:47:11Z

The quickstart video suggests installing git and mercurial, so I feel like users should have it installed.

Though this also suggests installing one or the other, so I suppose it isn't necessary. I think we could add the call in a try block. If it fails, warn the user that their directory will not be cleaned as they don't have git installed.

At worst, their directory would not be cleaned, but they could continue exporting. As it is, the command could fail with a traceback? Or it might simply print a windows command error, but the user might not associate it with their clean flag.

sarahmarshy · 2016-09-13T16:53:32Z

tools/project.py

@@ -200,8 +200,7 @@ def main():

    # Clean Export Directory
    if options.clean:
-        if exists(EXPORT_DIR):
-            rmtree(EXPORT_DIR)
+        Popen(["git", "clean", "-fe", "mbed-os"]).wait()


What about:

try: subprocess.check_call(["git", "clean", "-fe", "mbed-os"]) except subprocess.CalledProcessError: print "Warning: your directory will not be cleaned. Please install git to use the clean flag."

Yep. will do.

screamerbg · 2016-09-13T18:03:01Z

This should be rather a switch to mbed CLI which can clean the whole code during import (not just mbed OS)

theotherjimmy · 2016-09-13T18:08:51Z

Sounds good.

theotherjimmy · 2016-09-13T18:08:58Z

Closing.

…..225a4af 225a4af Remove files from tests folder 58d2c8f Merge remote-tracking branch 'origin/release_internal' into release_external 921b4b3 Wi-SUN FAN 1.1 dynamic MDR data request enabler b8722e8 Corrected BR removing of waiting list entry when supplicant is in key storage 0d54d7a Adjust trace levels (ARMmbed#2692) 681d9ea Added reset for pan id and version to BR network start 30d4fb2 Renaming and cleaning ws bootstrap (ARMmbed#2688) e0da19d Add Wi-SUN host configuration (ARMmbed#2690) 50ecc3d Refactoring Wi-SUN stack (ARMmbed#2686) 9d2386d Renamed operation mode to operating mode. 2f755bc RF config resolver and some refactoring (ARMmbed#2683) 86c6d19 Fixed WS IE PCAP read operation wrong length usage. cd3a4c2 Config: Remove additional HAVE_WS_ROUTER (ARMmbed#2684) cdd7f2d Added API for configure supported Phy capability. a00a3c0 Wi-SUN FAN 1.1 PCAP IE update 2d063d3 Moved State machine and timer functions to own files edb8bec Corrected system time check function return values 85358a6 Moved Wi-SUN Bootstrap Event handling to separate device handlers 61cbdde MAC to support mode switch on single channel (ARMmbed#2678) 1006d29 Added storing of PAN ID to NVM in BBR 7bf0028 Corrected system time jump detection on BR startup e60974d Split Wi-SUN bootstrap to device types a3f3412 MAC data req: API to support mode switch (ARMmbed#2674) cad5122 Removed automatic network size configuration (ARMmbed#2673) 35d3132 MAC: Callback set to resolve PHY mode ID (ARMmbed#2672) 0c5faca Added support for large system time changes (e.g. due to NTP) (ARMmbed#2670) c94b306 LFN version and LGTK Hash IE advertisment and learn 8e07511 Use FAN version constant instead of pure number a5566b2 Channel Plan 2 validation and FAN 1.0 reject 42dba41 Wi-Sun IE FAN 1.1 update 1d56070 EU channel plan ids (FAN 1.1) supported (ARMmbed#2668) fc4f41f Add test API empty function 37efc7e Add version 1.1 basic support e1558fb Implemented mode switch PHR build and parse (ARMmbed#2665) cbd8a15 Corrected frame counter storing threshold check 37f7ae9 Time configuration distribution using DHCPv6 vendor data 7415bc7 Added checks for Border Router frame counter space exhaustion (ARMmbed#2660) f1a65ec Mode switch PHY API (ARMmbed#2663) e54231b Do not check buffer age when virtual RF driver used (ARMmbed#2662) cc8c7bd arm_network_certificate_chain_set() returns -2 when PANA is disabled 319dd91 Fix dubious semicolon in #define 2ff51ab Remove extra '\n' in traces 19376c8 Simplify array indexes c808661 Fix ASAN warnings about overflows in bit shifts f998008 Fix use-after-free in mac_helper_coordinator_address_set() 4d04541 Wi-SUN header and Paylod IE element lenght future proof update. 935898b Medium network PAN_TIMEOUT changed to 30 minutes 1af7cfe Updated nanostack to be compatible with mbed TLS 3.0 (ARMmbed#2657) 29744e0 If Router Solicitation creation fails no longer tries to retry the RS right away (ARMmbed#2655) 2b889e9 Added automatic test procedure triggering during bootstrap ed9eb05 GTKs are removed only when fresh GTK hash is received 81ecdc2 Added empty function for test procedure trigger 14439b4 Added support for triggering test procedures b8a67a9 Update CHANGELOG.md for Nanostack 14.0.0 (ARMmbed#2649) git-subtree-dir: features/nanostack/sal-stack-nanostack git-subtree-split: 225a4af

…a3c5c5..225a4af 225a4af Remove files from tests folder 58d2c8f Merge remote-tracking branch 'origin/release_internal' into release_external 921b4b3 Wi-SUN FAN 1.1 dynamic MDR data request enabler b8722e8 Corrected BR removing of waiting list entry when supplicant is in key storage 0d54d7a Adjust trace levels (ARMmbed#2692) 681d9ea Added reset for pan id and version to BR network start 30d4fb2 Renaming and cleaning ws bootstrap (ARMmbed#2688) e0da19d Add Wi-SUN host configuration (ARMmbed#2690) 50ecc3d Refactoring Wi-SUN stack (ARMmbed#2686) 9d2386d Renamed operation mode to operating mode. 2f755bc RF config resolver and some refactoring (ARMmbed#2683) 86c6d19 Fixed WS IE PCAP read operation wrong length usage. cd3a4c2 Config: Remove additional HAVE_WS_ROUTER (ARMmbed#2684) cdd7f2d Added API for configure supported Phy capability. a00a3c0 Wi-SUN FAN 1.1 PCAP IE update 2d063d3 Moved State machine and timer functions to own files edb8bec Corrected system time check function return values 85358a6 Moved Wi-SUN Bootstrap Event handling to separate device handlers 61cbdde MAC to support mode switch on single channel (ARMmbed#2678) 1006d29 Added storing of PAN ID to NVM in BBR 7bf0028 Corrected system time jump detection on BR startup e60974d Split Wi-SUN bootstrap to device types a3f3412 MAC data req: API to support mode switch (ARMmbed#2674) cad5122 Removed automatic network size configuration (ARMmbed#2673) 35d3132 MAC: Callback set to resolve PHY mode ID (ARMmbed#2672) 0c5faca Added support for large system time changes (e.g. due to NTP) (ARMmbed#2670) c94b306 LFN version and LGTK Hash IE advertisment and learn 8e07511 Use FAN version constant instead of pure number a5566b2 Channel Plan 2 validation and FAN 1.0 reject 42dba41 Wi-Sun IE FAN 1.1 update 1d56070 EU channel plan ids (FAN 1.1) supported (ARMmbed#2668) fc4f41f Add test API empty function 37efc7e Add version 1.1 basic support e1558fb Implemented mode switch PHR build and parse (ARMmbed#2665) cbd8a15 Corrected frame counter storing threshold check 37f7ae9 Time configuration distribution using DHCPv6 vendor data 7415bc7 Added checks for Border Router frame counter space exhaustion (ARMmbed#2660) f1a65ec Mode switch PHY API (ARMmbed#2663) e54231b Do not check buffer age when virtual RF driver used (ARMmbed#2662) cc8c7bd arm_network_certificate_chain_set() returns -2 when PANA is disabled 319dd91 Fix dubious semicolon in #define 2ff51ab Remove extra '\n' in traces 19376c8 Simplify array indexes c808661 Fix ASAN warnings about overflows in bit shifts f998008 Fix use-after-free in mac_helper_coordinator_address_set() 4d04541 Wi-SUN header and Paylod IE element lenght future proof update. 935898b Medium network PAN_TIMEOUT changed to 30 minutes 1af7cfe Updated nanostack to be compatible with mbed TLS 3.0 (ARMmbed#2657) 29744e0 If Router Solicitation creation fails no longer tries to retry the RS right away (ARMmbed#2655) 2b889e9 Added automatic test procedure triggering during bootstrap ed9eb05 GTKs are removed only when fresh GTK hash is received 81ecdc2 Added empty function for test procedure trigger 14439b4 Added support for triggering test procedures b8a67a9 Update CHANGELOG.md for Nanostack 14.0.0 (ARMmbed#2649) git-subtree-dir: connectivity/nanostack/sal-stack-nanostack git-subtree-split: 225a4af

theotherjimmy mentioned this pull request Sep 13, 2016

Exporters - mbed export -c removes git repository #2690

Closed

theotherjimmy added 2 commits September 13, 2016 10:34

Remove cleaning functionality from project_api.

8dea671

It was possible to remove an entire project if clean was specified on the command line. That's a Bad Thing(tm).

Use git clean for cleaning up project files

998111d

Also tells you what it's removing

theotherjimmy force-pushed the clean-export-with-git branch from 2c4a31c to 998111d Compare September 13, 2016 15:35

sarahmarshy reviewed Sep 13, 2016
View reviewed changes

Improve export clean failure message

fafc9b8

theotherjimmy force-pushed the clean-export-with-git branch from 23fb814 to fafc9b8 Compare September 13, 2016 17:08

theotherjimmy closed this Sep 13, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tools-exporters! - Clean exports with git #2692

tools-exporters! - Clean exports with git #2692

theotherjimmy commented Sep 13, 2016

theotherjimmy commented Sep 13, 2016 •

edited

Loading

theotherjimmy commented Sep 13, 2016

bridadan commented Sep 13, 2016

sarahmarshy commented Sep 13, 2016 •

edited

Loading

sarahmarshy Sep 13, 2016 •

edited

Loading

theotherjimmy Sep 13, 2016

screamerbg commented Sep 13, 2016

theotherjimmy commented Sep 13, 2016

theotherjimmy commented Sep 13, 2016

tools-exporters! - Clean exports with git #2692

tools-exporters! - Clean exports with git #2692

Conversation

theotherjimmy commented Sep 13, 2016

theotherjimmy commented Sep 13, 2016 • edited Loading

theotherjimmy commented Sep 13, 2016

bridadan commented Sep 13, 2016

sarahmarshy commented Sep 13, 2016 • edited Loading

sarahmarshy Sep 13, 2016 • edited Loading

Choose a reason for hiding this comment

theotherjimmy Sep 13, 2016

Choose a reason for hiding this comment

screamerbg commented Sep 13, 2016

theotherjimmy commented Sep 13, 2016

theotherjimmy commented Sep 13, 2016

theotherjimmy commented Sep 13, 2016 •

edited

Loading

sarahmarshy commented Sep 13, 2016 •

edited

Loading

sarahmarshy Sep 13, 2016 •

edited

Loading