This week, im removing grc completely from gnuradio codebase and add auto format as a pre-commit git hook.

GRC Removal

The main idea is to just remove grc folder from gnuradio codebase, this can be achieved by removing necessary cmake codes into root CMakeLists.txt of gnuradio, and also moving freedesktop folder into root of gnuradio, this freedesktop folder is used to install logo for gtk grc.

Freedesktop

This process is quite simple, just move the folder into root of gnu radio, then modify CMakeLists.txt root:

1
2
3
...
add_subdirectory(freedesktop)
...

Moving the input conf file

in grc, there is grc.conf.in and 00-grc-docs.conf.in, the logic of using input config file into the root CMakeLists.txt. So, I modify the CMakeLists.txt into:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
...
########################################################################
# Install configuration files for GRC
########################################################################
configure_file(
    ${CMAKE_CURRENT_SOURCE_DIR}/grc.conf.in
    ${CMAKE_CURRENT_BINARY_DIR}/grc.conf
@ONLY)
configure_file(
    ${CMAKE_CURRENT_SOURCE_DIR}/00-grc-docs.conf.in
    ${CMAKE_CURRENT_BINARY_DIR}/00-grc-docs.conf
@ONLY)

install(
    FILES ${CMAKE_CURRENT_BINARY_DIR}/grc.conf
    DESTINATION ${GR_PREFSDIR}
)
install(
    FILES ${CMAKE_CURRENT_BINARY_DIR}/00-grc-docs.conf
    DESTINATION ${GR_PREFSDIR}
)
...

Set ENABLE_GRC variable in CMakeLists.txt

the variable ENABLE_GRC is being set in CMakeLists.txt inside grc directory, but since the grc now is a python package, mean no CMakeLists.txt is allowed, I also move this logic into root CMakeLists.txt. The modified CMakeLists.txt is:

1
2
3
4
5
6
...
GR_REGISTER_COMPONENT("gnuradio-companion" ENABLE_GRC
    ENABLE_GNURADIO_RUNTIME
    ENABLE_PYTHON
)
...

Updating my previous work

So, we deceided to make grc separation as a (kind of) separate project, that does not include any of my previous work. Because of this, my previous work (workflow separation) is kind of fall behind, before I go to the next step, I need to do git merge with my final work of grc separation (git merge with origin/grc-removal from my grc branch). Its lot of chaos to fix the conflicts, but I finally solved it, every tests is passed.

Pre Commit Autoformat

As stated in my proposal, I promised that I’m proposing to make autoformat as a pre commit hook, so people do not need to fix the code style by themself. I have made the pull request here.

How to install GNU Radio + GRC

You can either install GNU Radio first or GRC first, it does not matter.

1. Install GNU Radio
2. Move to grc root directory (same level as pyproject.toml), then run pip install .

Conclusions

• Now GRC has been removed from gnuradio codebase
• You can install grc using pip install
• Now GRC GTK will have icon, no matter either you install GNU Radio or GRC first
• The PR for autoformat pre commit has been made