Skip to content

Build System: make -C path/path doc fails in Base Folder #21278

@crasbe

Description

@crasbe

Description

Steps to reproduce the issue

Mikolai observed in #21277 (comment) that trying to make the docs from the base folder with a path specified will fail. For example:

cbuec@W11nMate:~/RIOTstuff$ mkdir riot-vanilla
cbuec@W11nMate:~/RIOTstuff$ cd riot-vanilla/
cbuec@W11nMate:~/RIOTstuff/riot-vanilla$ git clone https://github.com/RIOT-OS/RIOT
Cloning into 'RIOT'...
remote: Enumerating objects: 370088, done.
remote: Counting objects: 100% (314/314), done.
remote: Compressing objects: 100% (203/203), done.
remote: Total 370088 (delta 183), reused 114 (delta 111), pack-reused 369774 (from 3)
Receiving objects: 100% (370088/370088), 157.19 MiB | 12.47 MiB/s, done.
Resolving deltas: 100% (253339/253339), done.
Updating files: 100% (15815/15815), done.
cbuec@W11nMate:~/RIOTstuff/riot-vanilla$ cd RIOT/
cbuec@W11nMate:~/RIOTstuff/riot-vanilla/RIOT$ make -C examples/basic/hello-world doc
make: Entering directory '/home/cbuec/RIOTstuff/riot-vanilla/RIOT/examples/basic/hello-world'
make -BC /home/cbuec/RIOTstuff/riot-vanilla/RIOT doc
*** ERROR: unrecognized target "makefiles/color.inc.mk"

Welcome to RIOT - The friendly OS for IoT!

You executed 'make' from the base directory.
Usually, you should run 'make' in your application's directory instead.

Please see our Quick Start Guide at:
    https://doc.riot-os.org/getting-started.html
You can ask questions or discuss with other users on our forum:
    https://forum.riot-os.org

Available targets for the RIOT base directory include:
 generate-{board,driver,example,module,pkg,test,features}
 info-{applications,boards,emulated-boards} info-applications-supported-boards
 print-versions
 clean distclean pkg-clean
 doc doc-{man,latex}

==> tl;dr Try running:
    cd examples/basic/default
    make BOARD=<INSERT_BOARD_NAME>
make[1]: *** [Makefile:83: makefiles/color.inc.mk] Error 1
make: *** [/home/cbuec/RIOTstuff/riot-vanilla/RIOT/examples/basic/hello-world/../../../Makefile.include:883: doc] Error 2
make: Leaving directory '/home/cbuec/RIOTstuff/riot-vanilla/RIOT/examples/basic/hello-world'

Expected results

The documentation should build and the Welcome message should not be displayed.

Actual results

See above.

Versions

Latest master.

$ make print-versions

Operating System Environment
----------------------------
         Operating System: "Ubuntu" "22.04.5 LTS (Jammy Jellyfish)"
                   Kernel: Linux 5.15.167.4-microsoft-standard-WSL2 x86_64 x86_64
             System shell: /usr/bin/dash (probably dash)
             make's shell: /usr/bin/dash (probably dash)

Installed compiler toolchains
-----------------------------
               native gcc: gcc (Ubuntu 11.4.0-1ubuntu1~22.04) 11.4.0
        arm-none-eabi-gcc: arm-none-eabi-gcc (15:10.3-2021.07-4) 10.3.1 20210621 (release)
                  avr-gcc: missing
           msp430-elf-gcc: missing
       riscv-none-elf-gcc: missing
  riscv64-unknown-elf-gcc: missing
      riscv32-esp-elf-gcc: missing
     xtensa-esp32-elf-gcc: missing
   xtensa-esp32s2-elf-gcc: missing
   xtensa-esp32s3-elf-gcc: missing
   xtensa-esp8266-elf-gcc: missing
                    clang: Ubuntu clang version 14.0.0-1ubuntu1.1

Installed compiler libs
-----------------------
     arm-none-eabi-newlib: "3.3.0"
        msp430-elf-newlib: missing
    riscv-none-elf-newlib: missing
riscv64-unknown-elf-newlib: missing
   riscv32-esp-elf-newlib: missing
  xtensa-esp32-elf-newlib: missing
xtensa-esp32s2-elf-newlib: missing
xtensa-esp32s3-elf-newlib: missing
xtensa-esp8266-elf-newlib: missing
                 avr-libc: missing (missing)

Installed development tools
---------------------------
                   ccache: missing
                    cmake: cmake version 3.22.1
                 cppcheck: missing
                  doxygen: 1.12.0 (c73f5d30f9e8b1df5ba15a1d064ff2067cbb8267)
                      git: git version 2.34.1
                     make: GNU Make 4.3
                  openocd: Open On-Chip Debugger 0.11.0
                   python: missing
                  python2: missing
                  python3: Python 3.10.12
                   flake8: 4.0.1 (mccabe: 0.6.1, pycodestyle: 2.8.0, pyflakes: 2.4.0) CPython 3.10.12 on
               coccinelle: spatch version 1.1.1 compiled with OCaml version 4.13.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area: build systemArea: Build systemType: bugThe issue reports a bug / The PR fixes a bug (including spelling errors)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions