From 5a9399e4c257069e5d54c0fd670e1001eba2e8e2 Mon Sep 17 00:00:00 2001 From: Alexandre Abadie Date: Mon, 29 Jun 2020 11:57:22 +0200 Subject: [PATCH] pkg/doc.txt: improve rendering of source location documentation --- pkg/doc.txt | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/pkg/doc.txt b/pkg/doc.txt index 118f6e42ce..db349171e3 100644 --- a/pkg/doc.txt +++ b/pkg/doc.txt @@ -14,14 +14,23 @@ * INCLUDE += $(RIOTPKG)//... * ~~~~~~~~ * - * When the package can be build out-of-source, the source code of external - * packages is fetched in a global location in - * `$(RIOTBASE)/build/pkg/$(PKG_NAME)`. + * When the package can be built out-of-source, the source code of external + * packages is fetched in a global location in: + * + * ~~~~~~~~ {.mk} + * $(RIOTBASE)/build/pkg/$(PKG_NAME) + * ~~~~~~~~ + * * When out-of-source build is not possible (for example because the package - * build system doesn't allow it), the source code is fetch in the build - * directory of the application under `$(BINDIR)/pkg/$(PKG_NAME)` - * and is the same as the build directory (this is the case for micropython - * and openthread packages). + * build system doesn't allow it), the source code is fetched in the build + * directory of the application under: + * + * ~~~~~~~~ {.mk} + * $(BINDIR)/pkg/$(PKG_NAME) + * ~~~~~~~~ + * + * In this case, the source and the build directory are the same (currently, + * this applies to the micropython and openthread packages). * * Porting an external library * ===========================