Wiele osób początkujących aby wprowadzić jakieś testowe zmiany w swoim projekcie nie zawsze korzysta z GITa. Czasem też jest realna potrzeba na sklonowanie projektu, aby rozwijać go zupełnie osobno. Pierwsza myśl? Kopiuj-Wklej. Nie jest to złe rozwiązanie, ale korzystając z CubeIDE odkryjemy, że jest z tym dosyć spory problem.

Aktualizacja

Od wersji STM32CubeIDE 1.7.0 problem przestał występować. Zostawiam jednak artykuł, bo może gdzieś kiedyś wrócić 🙂

Moja historia z “problemem”

Aktualnie jestem w trakcie realizacji mojego największego projektu, jakim jest Kurs STM32 dla Poaczątkujących. Na jego potrzeby zmuszony jestem dzielić odpowiednie kawałki kodu na osobne projekty. Wszystko po to, aby lekcje były względnie odseparowane od siebie i kod z projektu do nich pasował.

Przykładowo pisząc UART używając Pollingu, zadeklarowałem jakieś zmienne itd. Generalnie coś w tym projekcie jest. Chciałbym teraz tą bazę wykorzystać do kolejnych lekcji, na przykład takiej o odbiorze z przerwaniami.

Jednak nie chcę ruszać tej bazy, bo będę ją udostępniał jako kody do lekcji wcześniejszej. Pomysł – kopia projektu. Prawy przycisk myszy -> Kopiuj -> Wklej obok.

Zmieniasz nazwę folderu. Zmieniasz nazwę pliku *.ioc dla Cube. Zresztą sam Cube zacznie krzyczeć, że folder i *.ioc musi nazywać się identycznie jak folder projektu, aby to działało.

Jest wszystko pięknie, piszesz kod w nowym projekcie i wszyscy się cieszą. Najbardziej to diabeł bo, gdy przychodzi ten moment, że chcesz wrzucić projekt-bazę dla kursantów okazuje się, że NIE MA W NIM PLIKÓW ŹRÓDŁOWYCH FOLDERU Src. WSZYSTKICH!

“Szok, rozpacz, niedowierzanie. Jakaś resztka nadziei”. Ten cytat znanego polityka ciśnie się na usta. Niektórym tak jak, mi nawet trochę ostrzejsze słowa. Projekt-baza wyparował. Nie ma nic. Co teraz? Niestety jeśli nie było żadnej kopii na zewnętrznym repozytorium – wszystko przepadło. Trzeba odtwarzać.

W czym leży problem?

Poguglałem, poczytałem, ale nie znalazłem prawidłowej odpowiedzi. Niektórzy mówią, że chodzi o plik ustawień projektu w IDE –  .project. Czyli problem powinien występować w każdym Eclipse’owym środowisku. Jednak nie pamiętam, abym kiedyś miał takie problemy przy AVRach… Kopiowałem, przenosiłem i modyfokowałem projekty na AVR bez żadnego znikania.

Problem niestety leży w CubeMX i jego opercjach na plikach. Dokładnie to w tym, do których ścieżek w projekcie się odwołuje. Kroki do odtworzenia znikania plików:

1. Tworzysz Projekt Źródło.
2. Generujesz w nim pliki przez CubeMX
3. Wchodzisz do folderu z projektami.
4. Kopiujesz Projekt Źródło
5. Wklejasz kopię
6. Zmieniasz nazwę Projektu Kopii
7. Zmieniasz nazwę *.ioc Projektu Kopii
8. Odpalasz *.ioc Projektu Kopii
9. Robisz zmiany jesli chcesz
10. Generujesz ponownie Projekt Kopię
11. Pliki Src w Projekt Źródło znikają

Dlaczego?

Każdy projekt CubeMX ma specjalny plik .mxproject w swoim katalogu. W nim jest informacja o tym jakich plików używa CubeMX do generowania projektu.

No i najważniejsza informacja – które pliki zostały wygenerowane poprzednio. Ma to na celu wytypowanie wszystkich plików, które mają podlegać przegenerowaniu. Z moich obserwacji wynika, że pliki “poprzednie” są kasowane w całości.

Brane z nich są jedynie fragmenty w znacznikach USER CODE i przepisywane są do kompletnie nowych plików. Cube nie bawi się w modyfikacje już istniejących plików. Kasuje je jak leci i przenosi jedynie kod użytkownika.

Po skopiowaniu “Projekt_Zrodlo” do “Projekt_Kopia” otworzyłem plik .mxproject. W środku wygląda tak.

[PreviousLibFiles]
LibFiles=Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_tim.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_tim_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_uart.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_rcc.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_rcc_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_flash.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_flash_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_flash_ramfunc.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_gpio.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_gpio_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_dma_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_dma.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_pwr.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_pwr_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_cortex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal.h;Drivers/STM32F4xx_HAL_Driver/Inc/Legacy/stm32_hal_legacy.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_exti.h;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_tim.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_tim_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_uart.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_rcc.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_rcc_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash_ramfunc.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_gpio.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_dma_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_dma.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_pwr.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_pwr_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cortex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_exti.c;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_tim.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_tim_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_uart.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_rcc.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_rcc_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_flash.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_flash_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_flash_ramfunc.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_gpio.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_gpio_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_dma_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_dma.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_pwr.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_pwr_ex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_cortex.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal.h;Drivers/STM32F4xx_HAL_Driver/Inc/Legacy/stm32_hal_legacy.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h;Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_exti.h;Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f411xe.h;Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h;Drivers/CMSIS/Device/ST/STM32F4xx/Include/system_stm32f4xx.h;Drivers/CMSIS/Device/ST/STM32F4xx/Source/Templates/system_stm32f4xx.c;Drivers/CMSIS/Include/cmsis_armcc.h;Drivers/CMSIS/Include/cmsis_armclang.h;Drivers/CMSIS/Include/cmsis_compiler.h;Drivers/CMSIS/Include/cmsis_gcc.h;Drivers/CMSIS/Include/cmsis_iccarm.h;Drivers/CMSIS/Include/cmsis_version.h;Drivers/CMSIS/Include/core_armv8mbl.h;Drivers/CMSIS/Include/core_armv8mml.h;Drivers/CMSIS/Include/core_cm0.h;Drivers/CMSIS/Include/core_cm0plus.h;Drivers/CMSIS/Include/core_cm1.h;Drivers/CMSIS/Include/core_cm23.h;Drivers/CMSIS/Include/core_cm3.h;Drivers/CMSIS/Include/core_cm33.h;Drivers/CMSIS/Include/core_cm4.h;Drivers/CMSIS/Include/core_cm7.h;Drivers/CMSIS/Include/core_sc000.h;Drivers/CMSIS/Include/core_sc300.h;Drivers/CMSIS/Include/mpu_armv7.h;Drivers/CMSIS/Include/mpu_armv8.h;Drivers/CMSIS/Include/tz_context.h;

[PreviousUsedCubeIDEFiles]
SourceFiles=Core\Src\main.c;Core\Src\stm32f4xx_it.c;Core\Src\stm32f4xx_hal_msp.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_tim.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_tim_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_uart.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_rcc.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_rcc_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash_ramfunc.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_gpio.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_dma_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_dma.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_pwr.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_pwr_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cortex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_exti.c;Core\Src/system_stm32f4xx.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_tim.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_tim_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_uart.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_rcc.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_rcc_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_flash_ramfunc.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_gpio.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_dma_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_dma.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_pwr.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_pwr_ex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cortex.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal.c;Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_exti.c;Core\Src/system_stm32f4xx.c;Drivers/CMSIS/Device/ST/STM32F4xx/Source/Templates/system_stm32f4xx.c;;
HeaderPath=Drivers\STM32F4xx_HAL_Driver\Inc;Drivers\STM32F4xx_HAL_Driver\Inc\Legacy;Drivers\CMSIS\Device\ST\STM32F4xx\Include;Drivers\CMSIS\Include;Core\Inc;
CDefines=USE_HAL_DRIVER;STM32F411xE;USE_HAL_DRIVER;USE_HAL_DRIVER;

[PreviousGenFiles]
AdvancedFolderStructure=true
HeaderFileListSize=3
HeaderFiles#0=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Inc/stm32f4xx_it.h
HeaderFiles#1=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Inc/stm32f4xx_hal_conf.h
HeaderFiles#2=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Inc/main.h
HeaderFolderListSize=1
HeaderPath#0=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Inc
HeaderFiles=;
SourceFileListSize=3
SourceFiles#0=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Src/stm32f4xx_it.c
SourceFiles#1=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Src/stm32f4xx_hal_msp.c
SourceFiles#2=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Src/main.c
SourceFolderListSize=1
SourcePath#0=D:/LIVE/Workspace/Projekt_Zrodlo/Core/Src
SourceFiles=;

Zwróć uwagę na sekcję [PreviousGenFiles]. Tam są ścieżki do projektu-źródła. Do tego są to ścieżki BEZWZGLĘDNE. Te pliki są kasowane przy regeneracji projektu. Jeśli tak, to można ścieżkę, a w zasadzie to samą nazwę projektu podmienić na nową, prawda?

Po podmianie sekcja [PreviousGenFiles] wygląda tak.

[PreviousGenFiles]
AdvancedFolderStructure=true
HeaderFileListSize=3
HeaderFiles#0=D:/LIVE/Workspace/Projekt_Kopia/Core/Inc/stm32f4xx_it.h
HeaderFiles#1=D:/LIVE/Workspace/Projekt_Kopia/Core/Inc/stm32f4xx_hal_conf.h
HeaderFiles#2=D:/LIVE/Workspace/Projekt_Kopia/Core/Inc/main.h
HeaderFolderListSize=1
HeaderPath#0=D:/LIVE/Workspace/Projekt_Kopia/Core/Inc
HeaderFiles=;
SourceFileListSize=3
SourceFiles#0=D:/LIVE/Workspace/Projekt_Kopia/Core/Src/stm32f4xx_it.c
SourceFiles#1=D:/LIVE/Workspace/Projekt_Kopia/Core/Src/stm32f4xx_hal_msp.c
SourceFiles#2=D:/LIVE/Workspace/Projekt_Kopia/Core/Src/main.c
SourceFolderListSize=1
SourcePath#0=D:/LIVE/Workspace/Projekt_Kopia/Core/Src
SourceFiles=;

Próba przegenerowania projektu-kopii nie niszczy już projektu-źródła!

Sukces!

Jakiś FIX na to Panie ST?

Fix byłby banalnie prosty. Wystarczyłoby zamienić ścieżki bezwzględne na ścieżki względne w pliku .mxproject. Jednak to musiałoby zrobić już samo ST w swoim narzędziu.

Ciekawe jest to, że we wsześniejszych sekcjach pliku .mxproject są właśnie ścieżki względne. Jestem ciekaw czym kierowało się ST robiąc coś takiego…

Bo dosyć łatwo będzie nam odkryć taką niespodziankę w tym samym Workspace. Gorzej, jeśli przeniesiemy projekt zupełnie gdzie indziej. Wtedy czai się uzbrojona bomba, która tylko czekana usunięcie plików spod bezwzględnej ścieżki 🙂

Podsumowanie

Problem jest i to dosyć spory. Narobił mi kilka dodatkowych godzin roboty przy kursie. Kurs to pół biedy. Gorzej, gdyby skasowane zostały jakieś grube projekty komercyjne.

Jedno jest pewnie – backupy, backupy, backupy. Trzeba robić backupy poza naszym komputerem. Git z chmurowym repozytorium będzie do tego odpowiedni. Wtedy łatwo taką niespodziankę jest po prostu odwrócić.

Fajnie jakby ST poprawiło ten problem. Kto wie, może trafi do nich mój post. Byłoby mi miło 🙂

Póki co pamiętaj co trzeba robić, aby być bezpiecznym projektowo.

Jeśli artykuł Ci się spodobał, kup coś u mnie!  https://sklep.msalamon.pl/

Jeśli zauważyłeś jakiś błąd, nie zgadzasz się z czymś, chciałbyś coś dodać istotnego lub po prostu uważasz, że chciałbyś podyskutować na ten temat, napisz komentarz. Pamiętaj, że dyskusja ma być kulturalna i zgodna z zasadami języka polskiego.