From ab05b9522ceb15b40bb17621938b36b37bbe6b76 Mon Sep 17 00:00:00 2001 From: Carles Fernandez Date: Sun, 6 Oct 2024 09:52:12 +0200 Subject: [PATCH] Update to the new source tree structure --- _posts/2016-06-23-rtl2832U.md | 2 +- ...3-07-configuration-options-building-time.md | 18 +++++++++++++++++- _posts/2018-06-07-gnss-sdr-v0010-released.md | 4 ++-- .../2018-06-30-testing-software-receiver-2.md | 9 +++++---- _quick-start/03-build-and-install.md | 6 ++++-- _sp-blocks/01-global-parameters.md | 6 +++--- _sp-blocks/02-signal-source.md | 6 +++--- 7 files changed, 35 insertions(+), 16 deletions(-) diff --git a/_posts/2016-06-23-rtl2832U.md b/_posts/2016-06-23-rtl2832U.md index 91415d9b..e8be43c8 100644 --- a/_posts/2016-06-23-rtl2832U.md +++ b/_posts/2016-06-23-rtl2832U.md @@ -306,7 +306,7 @@ based on the ones on Key Borre's book[^Borre06] and available at [^Borre06]: K. Borre, D. M. Akos, N. Bertelsen, P. Rinder, S. H. Jensen, _A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach_, 1st edition, Boston: Birkhäuser, November 2006. - * [gnss-sdr/src/utils/matlab/dll_pll_veml_plot_sample.m](https://github.com/gnss-sdr/gnss-sdr/blob/main/src/utils/matlab/dll_pll_veml_plot_sample.m) + * [gnss-sdr/utils/matlab/dll_pll_veml_plot_sample.m](https://github.com/gnss-sdr/gnss-sdr/blob/next/utils/matlab/dll_pll_veml_plot_sample.m) The figure clearly shows the GPS C/A navigation symbols, The PLL and DLL diff --git a/_posts/2017-03-07-configuration-options-building-time.md b/_posts/2017-03-07-configuration-options-building-time.md index 78283c16..200b2361 100644 --- a/_posts/2017-03-07-configuration-options-building-time.md +++ b/_posts/2017-03-07-configuration-options-building-time.md @@ -53,12 +53,22 @@ Once all the required dependencies are installed in your system, the default building process is: ```console -$ cd gnss-sdr/build +$ cd gnss-sdr && git checkout next +$ mkdir -p build && cd build $ cmake .. $ make $ sudo make install ``` +or, alternatively: + +```console +$ cd gnss-sdr && git checkout next +$ cmake -S . -B build +$ cmake --build build +$ sudo cmake --install build +``` + CMake's defaults and GNSS-SDR project configuration settings can be overridden on the command line with the -D option, with the following syntax: @@ -67,6 +77,12 @@ $ cmake -D= ``` {: class="no-copy"} +or, if you are using CMake's binary options: + +```console +$ cmake -S . -B build -D= +``` + Thus, if you want to set the variable named `CMAKE_BUILD_TYPE` to the `Debug` value, you can write in your command line: diff --git a/_posts/2018-06-07-gnss-sdr-v0010-released.md b/_posts/2018-06-07-gnss-sdr-v0010-released.md index b96b9c1e..7e581e4f 100644 --- a/_posts/2018-06-07-gnss-sdr-v0010-released.md +++ b/_posts/2018-06-07-gnss-sdr-v0010-released.md @@ -71,7 +71,7 @@ This release has several improvements in different dimensions, addition of new f * Improvements in the correctness of generated RINEX files. * The receiver can read and make use of Galileo [almanac XML files published by the European GNSS Service Centre](https://www.gsc-europa.eu/gsc-products/almanac). * Own-defined XML schemas for navigation data published [here](https://github.com/gnss-sdr/gnss-sdr/tree/next/docs/xml-schemas) - * Added program rinex2assist to convert RINEX navigation files into XML files usable for Assisted GNSS. Only available building from source. See the [README](https://github.com/gnss-sdr/gnss-sdr/tree/next/src/utils/rinex2assist). + * Added program rinex2assist to convert RINEX navigation files into XML files usable for Assisted GNSS. Only available building from source. See the [README](https://github.com/gnss-sdr/gnss-sdr/tree/next/utils/rinex2assist). @@ -124,7 +124,7 @@ This release has several improvements in different dimensions, addition of new f ## Improvements in [Reproducibility]({{ "/design-forces/reproducibility/" | relative_url }}): - * Setup of a Continuous Reproducibility system at GitLab for the automatic reproduction of experiments. The concept was introduced in [this paper](https://ieeexplore.ieee.org/document/8331069/). Example added in the [`src/utils/reproducibility/ieee-access18/`](https://github.com/gnss-sdr/gnss-sdr/tree/next/src/utils/reproducibility/ieee-access18) folder. + * Setup of a Continuous Reproducibility system at GitLab for the automatic reproduction of experiments. The concept was introduced in [this paper](https://ieeexplore.ieee.org/document/8331069/). Example added in the [`utils/reproducibility/ieee-access18/`](https://github.com/gnss-sdr/gnss-sdr/tree/next/utils/reproducibility/ieee-access18) folder. * Fixes of Lintian warnings related to build reproducibility. ## Improvements in [Scalability]({{ "/design-forces/scalability/" | relative_url }}): diff --git a/_posts/2018-06-30-testing-software-receiver-2.md b/_posts/2018-06-30-testing-software-receiver-2.md index 8d94c593..c8bad468 100644 --- a/_posts/2018-06-30-testing-software-receiver-2.md +++ b/_posts/2018-06-30-testing-software-receiver-2.md @@ -57,8 +57,9 @@ By default, only a (large) subset of unit tests is compiled (see details [below]({{ "#unit-tests" }})). So, when doing: ```console -$ cd gnss-sdr/build +$ cd gnss-sdr $ git checkout next +$ mkdir build && cd build $ cmake .. $ make $ make check # THIS STEP IS OPTIONAL. It builds and runs a subset of tests. @@ -927,17 +928,17 @@ place your testing code in an adequate folder from the GNSS-SDR source tree: Once the test code is written, you need to build and link it against the Google Test library. This process is managed in the file -[gnss-sdr/src/tests/CMakeLists.txt](https://github.com/gnss-sdr/gnss-sdr/blob/next/src/tests/CMakeLists.txt). +[gnss-sdr/tests/CMakeLists.txt](https://github.com/gnss-sdr/gnss-sdr/blob/next/tests/CMakeLists.txt). You will need to list your new test in the appropriate place in order to include it in the building: * If your test is a Unit Test, please `#include` it in the file - [gnss-sdr/src/tests/test_main.cc](https://github.com/gnss-sdr/gnss-sdr/blob/next/src/tests/test_main.cc) + [gnss-sdr/tests/test_main.cc](https://github.com/gnss-sdr/gnss-sdr/blob/next/tests/test_main.cc) and rebuild the source code. It should be getting included in the test program `run_tests`. * If your test is a System Test, please modify accordingly the file - [gnss-sdr/src/tests/CMakeLists.txt](https://github.com/gnss-sdr/gnss-sdr/blob/next/src/tests/CMakeLists.txt) + [gnss-sdr/tests/CMakeLists.txt](https://github.com/gnss-sdr/gnss-sdr/blob/next/tests/CMakeLists.txt) to define a new target and then rebuild the source code to get the new executable. diff --git a/_quick-start/03-build-and-install.md b/_quick-start/03-build-and-install.md index 3cc0480b..2c4fa802 100644 --- a/_quick-start/03-build-and-install.md +++ b/_quick-start/03-build-and-install.md @@ -266,8 +266,9 @@ the repository, build the source code and install the software in your system: ```console $ git clone https://github.com/gnss-sdr/gnss-sdr -$ cd gnss-sdr/build +$ cd gnss-sdr $ git checkout next +$ mkdir -p build && cd build $ cmake .. $ make $ sudo make install @@ -308,8 +309,9 @@ that is used by the Ninja build system to compile and link the source code. Thus, after cloning the repository, the build workflow is: ```console -$ cd gnss-sdr/build +$ cd gnss-sdr $ git checkout next +$ mkdir -p build && cd build $ cmake -GNinja .. $ ninja $ sudo ninja install diff --git a/_sp-blocks/01-global-parameters.md b/_sp-blocks/01-global-parameters.md index f1fc6ecb..374b8c66 100644 --- a/_sp-blocks/01-global-parameters.md +++ b/_sp-blocks/01-global-parameters.md @@ -139,9 +139,9 @@ client (_e.g._, with a telnet client) to the TCP port specified in the configuration file for telecommand. In order to use it, the executable `gnss-sdr` must be called with the -[gnss-sdr-harness.sh](https://github.com/gnss-sdr/gnss-sdr/blob/next/src/utils/scripts/gnss-sdr-harness.sh) +[gnss-sdr-harness.sh](https://github.com/gnss-sdr/gnss-sdr/blob/next/utils/scripts/gnss-sdr-harness.sh) script provided at -[src/utils/scripts](https://github.com/gnss-sdr/gnss-sdr/tree/next/src/utils/scripts): +[utils/scripts](https://github.com/gnss-sdr/gnss-sdr/tree/next/utils/scripts): ```console $ gnss-sdr-harness.sh gnss-sdr -c config_file.conf @@ -338,7 +338,7 @@ as a reference. So, if you are using the receiver with live signals from an RF front-end, you do not need to set this parameter. You could find useful the utility program -[rinex2assist](https://github.com/gnss-sdr/gnss-sdr/tree/next/src/utils/rinex2assist) +[rinex2assist](https://github.com/gnss-sdr/gnss-sdr/tree/next/utils/rinex2assist) for the generation of compatible XML files from recent, publicly available RINEX navigation data files. diff --git a/_sp-blocks/02-signal-source.md b/_sp-blocks/02-signal-source.md index bfcf6b6a..98d5fad5 100644 --- a/_sp-blocks/02-signal-source.md +++ b/_sp-blocks/02-signal-source.md @@ -1034,7 +1034,7 @@ Once gr-iio is installed, build GNSS-SDR passing the flag `-DENABLE_FMCOMMS2=ON` at configure time: ```console -$ cd gnss-sdr/build +$ cd gnss-sdr && mkdir build && cd build $ git checkout next $ git pull upstream next $ cmake -DENABLE_FMCOMMS2=ON .. @@ -1136,7 +1136,7 @@ Once gr-iio is installed, build GNSS-SDR passing the flag `-DENABLE_PLUTOSDR=ON` at configure time: ```console -$ cd gnss-sdr/build +$ cd gnss-sdr && mkdir build && cd build $ git checkout next $ git pull upstream next $ cmake -DENABLE_PLUTOSDR=ON .. @@ -1215,7 +1215,7 @@ Once `gr-limesdr` is installed, build GNSS-SDR passing the flag `-DENABLE_LIMESDR=ON` at configure time: ```console -$ cd gnss-sdr/build +$ cd gnss-sdr && mkdir build && cd build $ git checkout next $ git pull upstream next $ cmake -DENABLE_LIMESDR=ON ..