From cb9c5d00dea091050a3965043a1d0c523642a8c4 Mon Sep 17 00:00:00 2001 From: Christian Mehlis <mehlis@inf.fu-berlin.de> Date: Mon, 10 Feb 2014 15:28:55 +0100 Subject: [PATCH] repace project by application in documentation --- Makefile.include | 6 +++--- boards/avsextrem/include/configure.h | 4 ++-- cpu/native/README | 2 +- dist/Makefile | 10 +++++----- doc/doxygen/src/mainpage.txt | 16 ++++++++-------- drivers/include/cc110x/cc1100-interface.h | 2 +- examples/ccn-lite-client/Makefile | 2 +- examples/ccn-lite-relay/Makefile | 2 +- examples/default/Makefile | 2 +- examples/hello-world/Makefile | 2 +- examples/ipc_pingpong/Makefile | 2 +- examples/rpl_udp/Makefile | 2 +- pkg/PORTING | 4 ++-- pkg/USING | 4 ++-- sys/include/auto_init.h | 4 ++-- sys/include/shell.h | 2 +- sys/net/ccn_lite/README.md | 2 +- tests/test_bloom/Makefile | 2 +- tests/test_bloom_bytes/Makefile | 2 +- tests/test_float/Makefile | 2 +- tests/test_hwtimer/Makefile | 2 +- tests/test_hwtimer/main.c | 2 +- tests/test_hwtimer_spin/Makefile | 2 +- tests/test_irq/Makefile | 2 +- tests/test_nativenet/Makefile | 2 +- tests/test_pnet/Makefile | 2 +- tests/test_semaphore/Makefile | 2 +- tests/test_sha256/Makefile | 2 +- tests/test_shell/Makefile | 2 +- tests/test_shell/ReadMe.txt | 4 ++-- tests/test_thread_basic/Makefile | 2 +- tests/test_thread_exit/Makefile | 2 +- tests/test_thread_msg/Makefile | 2 +- tests/test_vtimer_msg/Makefile | 2 +- 34 files changed, 52 insertions(+), 52 deletions(-) diff --git a/Makefile.include b/Makefile.include index 6eaa239fff..3349298264 100644 --- a/Makefile.include +++ b/Makefile.include @@ -79,9 +79,9 @@ BASELIBS += $(USEPKG:%=${BINDIR}%.a) .PHONY: all clean flash doc term -## make script for your project. Build RIOT-base here! +## make script for your application. Build RIOT-base here! all: $(BINDIR)$(PROJECT).a - @echo "Building project $(PROJECT) for $(BOARD) w/ MCU $(MCU)." + @echo "Building application $(PROJECT) for $(BOARD) w/ MCU $(MCU)." "$(MAKE)" -C $(RIOTBOARD)/$(BOARD) "$(MAKE)" -C $(RIOTBASE) @for i in $(USEPKG) ; do "$(MAKE)" -C $(RIOTBASE)/pkg/$$i ; done ; @@ -94,7 +94,7 @@ endif $(AD)$(OBJCOPY) $(OFLAGS) $(BINDIR)$(PROJECT).elf $(BINDIR)$(PROJECT).hex ## your make rules -## Only basic example - modify it for larger projects!! +## Only basic example - modify it for larger applications!! #$(BINDIR)/$(PROJECT).a: $(BINDIR)/$(PROJECT).o # $(AR) -rc $(BINDIR)/project.a $(BINDIR)/$(PROJECT).o diff --git a/boards/avsextrem/include/configure.h b/boards/avsextrem/include/configure.h index 5ca52843a1..64cffecefc 100644 --- a/boards/avsextrem/include/configure.h +++ b/boards/avsextrem/include/configure.h @@ -26,10 +26,10 @@ * * The offline configuration file "configure.h" is automatically * included in every file by the build system and allows to configure - * all neccessary defines on cpu, board and project level. + * all neccessary defines on cpu, board and application level. * * The configuration is built of - * \li a project specific file (project-conf.h) + * \li a application specific file (project-conf.h) * \li a board specific file (board-conf.h) and * \li a cpu specific file (cpu-conf.h). * All of which are chosen by the build system depending on your arguments. diff --git a/cpu/native/README b/cpu/native/README index 956a815f49..b36ecfb677 100644 --- a/cpu/native/README +++ b/cpu/native/README @@ -1,7 +1,7 @@ VALGRIND SUPPORT ================ -Rebuild your project using the all-valgrind target like this: +Rebuild your application using the all-valgrind target like this: make -B clean all-valgrind diff --git a/dist/Makefile b/dist/Makefile index 23d16d80d0..7d04576e46 100644 --- a/dist/Makefile +++ b/dist/Makefile @@ -1,12 +1,12 @@ #### -#### Sample Makefile for building projects with the RIOT OS +#### Sample Makefile for building applications with the RIOT OS #### #### The example file system layout is: -#### ./project makefile +#### ./application makefile #### ../../RIOT #### -# Set the name of your project: +# Set the name of your application: export PROJECT = foobar # If no BOARD is found in the environment, use this default: @@ -46,9 +46,9 @@ export QUIET ?= 1 #USEMODULE += cc110x #USEMODULE += fat -#export INCLUDES += -Iproject_include +#export INCLUDES += -I application_include -# Specify custom dependencies for your project here ... +# Specify custom dependencies for your application here ... # export PROJDEPS = proj_data.h include $(RIOTBASE)/Makefile.include diff --git a/doc/doxygen/src/mainpage.txt b/doc/doxygen/src/mainpage.txt index 5857573d12..ad72867178 100644 --- a/doc/doxygen/src/mainpage.txt +++ b/doc/doxygen/src/mainpage.txt @@ -20,7 +20,7 @@ * code](https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-getting-the-source-code)). This contains - besides the * before mentioned features - also some example applications (located in the * `examples` subdirectory) and a sample Makefile you may use for your own - * project. This Makefile template shows you how to compile and link your project + * project. This Makefile template shows you how to compile and link your application * against RIOT ([Compiling RIOT](https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-compiling-riot)). * * If you want to use RIOT directly with your embedded platform, you need to @@ -33,7 +33,7 @@ * As a special platform, you will find a CPU and board called `native` in the * repository. This target allows you to run RIOT as a process on Linux on most * supported hardware platforms. Just set CPU and BOARD to `native` in your - * project's Makefile, call `make`, and execute the resulting elf-file. Further + * application's Makefile, call `make`, and execute the resulting elf-file. Further * documentation about the native port can be found in `cpu/native/README`. * * \subsection structure Structure @@ -68,15 +68,15 @@ * ####The build system * * RIOT uses GNU make as build system. The simplest way to compile and link a - * project (application or library) with RIOT, is to set up a Makefile providing + * application (application or library) with RIOT, is to set up a Makefile providing * at least the following variables: * * PROJECT * * BOARD * * RIOTBASE * * and an instruction to include the `Makefile.include`, located in RIOT's root - * directory. `PROJECT` should contain the (unique) name of your project, `BOARD` - * specifies the platform the project should be built for by default, and + * directory. `PROJECT` should contain the (unique) name of your application, `BOARD` + * specifies the platform the application should be built for by default, and * `RIOTBASE` specifies the path to your copy of the RIOT repository (note, that * you may want to use `$(CURDIR)` here, to give a relative path). You can use Make's * `?=` operator in order to allow overwriting variables from the command line. For @@ -102,10 +102,10 @@ * * ####Including modules * - * By default a RIOT project comprises only the projects' code itself, the kernel, + * By default a RIOT application comprises only the applications' code itself, the kernel, * and platform specific code. In order to use additional modules, such as a * particular device driver or a system library, you have to append the modules' - * names to the USEMODULE variable. For example, to build a project using the SHT11 + * names to the USEMODULE variable. For example, to build a application using the SHT11 * temperature sensor and 6LoWPAN network stack, your Makefile needs to contain * these lines: * \code @@ -124,7 +124,7 @@ * power mode for the device. The main thread - configured with a default priority * that is right in the middle between the lowest and the highest available * priority - is the first thread that runs and calls the main function. This - * function needs to be defined by the project. + * function needs to be defined by the application. * * ####Choosing the right stack size * diff --git a/drivers/include/cc110x/cc1100-interface.h b/drivers/include/cc110x/cc1100-interface.h index 305ece2327..cee27deafb 100644 --- a/drivers/include/cc110x/cc1100-interface.h +++ b/drivers/include/cc110x/cc1100-interface.h @@ -51,7 +51,7 @@ and Telematics group (http://cst.mi.fu-berlin.de). #define CC1100_MAX_DATA_LENGTH (58) // Define default radio mode to constant RX if no -// project specific setting is available. +// application specific setting is available. #ifndef CC1100_RADIO_MODE #ifdef MODULE_RPL #warning RPL currently works with CC1100_MODE_WOR diff --git a/examples/ccn-lite-client/Makefile b/examples/ccn-lite-client/Makefile index 28680a180d..15d646097e 100644 --- a/examples/ccn-lite-client/Makefile +++ b/examples/ccn-lite-client/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = ccn-lite-client # If no BOARD is found in the environment, use this default: diff --git a/examples/ccn-lite-relay/Makefile b/examples/ccn-lite-relay/Makefile index 96cf6d919e..93d41ff0c1 100644 --- a/examples/ccn-lite-relay/Makefile +++ b/examples/ccn-lite-relay/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = ccn-lite-relay # If no BOARD is found in the environment, use this default: diff --git a/examples/default/Makefile b/examples/default/Makefile index 93cf585e4b..2070303e64 100644 --- a/examples/default/Makefile +++ b/examples/default/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = default # If no BOARD is found in the environment, use this default: diff --git a/examples/hello-world/Makefile b/examples/hello-world/Makefile index 0b98fa9590..d7062d96c6 100644 --- a/examples/hello-world/Makefile +++ b/examples/hello-world/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = hello-world # If no BOARD is found in the environment, use this default: diff --git a/examples/ipc_pingpong/Makefile b/examples/ipc_pingpong/Makefile index 53c54937ab..85d482d931 100644 --- a/examples/ipc_pingpong/Makefile +++ b/examples/ipc_pingpong/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = ipc_pingpong # If no BOARD is found in the environment, use this default: diff --git a/examples/rpl_udp/Makefile b/examples/rpl_udp/Makefile index aeaf0c4197..2228c286b9 100644 --- a/examples/rpl_udp/Makefile +++ b/examples/rpl_udp/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = rpl_udp # If no BOARD is found in the environment, use this default: diff --git a/pkg/PORTING b/pkg/PORTING index 3a535146df..8712027060 100644 --- a/pkg/PORTING +++ b/pkg/PORTING @@ -2,9 +2,9 @@ This directory provides some porting information for libraries and programs to use with RIOT (to build an external module). If you'd like to add a package to RIOT you need to add a directory with the name of your package to this directory. Your directory should contain at least two files: - * patch.txt - Your patch of the upstream project of the package to make it + * patch.txt - Your patch of the upstream application of the package to make it build with RIOT - * Makefile - A Makefile describing how to get the upstream project, apply + * Makefile - A Makefile describing how to get the upstream application, apply the patch and how to build the package as a RIOT module. A rough template for several methods of acquiring a package is provided in Makefile.git, Makefile.http, and Makefile.svn \ No newline at end of file diff --git a/pkg/USING b/pkg/USING index 06964f2813..b5aa665e24 100644 --- a/pkg/USING +++ b/pkg/USING @@ -1,5 +1,5 @@ -Packages are included to your project as external modules. Thus you only have -to add the following line to your project (and update your INCLUDE path +Packages are included to your application as external modules. Thus you only have +to add the following line to your application (and update your INCLUDE path accordingly): USEPKG += <pkg_name> diff --git a/sys/include/auto_init.h b/sys/include/auto_init.h index 3b13d5ec87..95b8c4bc81 100644 --- a/sys/include/auto_init.h +++ b/sys/include/auto_init.h @@ -3,8 +3,8 @@ * @defgroup sys_autoinit Auto-init * @ingroup sys * @brief Auto initialize modules - * @note This feature can be used by any project by adding auto_init to - * USEMODULE in the project's Makefile. auto_init will initialize + * @note This feature can be used by any application by adding auto_init to + * USEMODULE in the application's Makefile. auto_init will initialize * any other included module that does not require a parameter in * its init function, i.e. if the prototype looks like this: void * MODULE_init(void). Most timer modules or simple drivers can be diff --git a/sys/include/shell.h b/sys/include/shell.h index 0e22520446..b3776b98aa 100644 --- a/sys/include/shell.h +++ b/sys/include/shell.h @@ -38,7 +38,7 @@ typedef struct shell_t { /** * @brief Initialize a shell object * @param shell Pointer to preallocated shell object - * @param shell_commands Pointer to shell command structure. See test_shell project for example. + * @param shell_commands Pointer to shell command structure. See test_shell application for example. * @param shell_buffer_size The size of the shell buffer. * @param read_char Pointer to input device read function. Should return exactly one byte or block. * @param put_char Pointer to output funtion. currently unused, shell code will use printf. diff --git a/sys/net/ccn_lite/README.md b/sys/net/ccn_lite/README.md index ece899c864..37c0eb9e92 100644 --- a/sys/net/ccn_lite/README.md +++ b/sys/net/ccn_lite/README.md @@ -30,7 +30,7 @@ If this chunk has the default chunk size the next chunk is requested, ... If a smaller chunk arrives the user land code prints out the complete file which was requested. To populate the cache type `ccn 100` and `populate`. -You can test this functionality by typing `interest /riot/text` in the shell. *See HOWTO.md in the projects directory*. +You can test this functionality by typing `interest /riot/text` in the shell. *See HOWTO.md in the applications directory*. ### ccn-lite-relay diff --git a/tests/test_bloom/Makefile b/tests/test_bloom/Makefile index 893f546862..16d9f21ac5 100644 --- a/tests/test_bloom/Makefile +++ b/tests/test_bloom/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_bloom # for easy switching of boards diff --git a/tests/test_bloom_bytes/Makefile b/tests/test_bloom_bytes/Makefile index 74998e3a81..0c7eda5a7b 100644 --- a/tests/test_bloom_bytes/Makefile +++ b/tests/test_bloom_bytes/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_bloom # for easy switching of boards diff --git a/tests/test_float/Makefile b/tests/test_float/Makefile index 8691cd768f..a9629dc0df 100644 --- a/tests/test_float/Makefile +++ b/tests/test_float/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_float # for easy switching of boards diff --git a/tests/test_hwtimer/Makefile b/tests/test_hwtimer/Makefile index 07a62ace56..1f0b4778a2 100644 --- a/tests/test_hwtimer/Makefile +++ b/tests/test_hwtimer/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_hwtimer export BOARD ?= native diff --git a/tests/test_hwtimer/main.c b/tests/test_hwtimer/main.c index 26641306ca..86177cefba 100644 --- a/tests/test_hwtimer/main.c +++ b/tests/test_hwtimer/main.c @@ -29,7 +29,7 @@ void callback(void *ptr) int main(void) { - puts("hwtimer test project..."); + puts("hwtimer test application..."); puts("Initializing hwtimer..."); hwtimer_init(); diff --git a/tests/test_hwtimer_spin/Makefile b/tests/test_hwtimer_spin/Makefile index 9ab2083faf..49199b8ad3 100644 --- a/tests/test_hwtimer_spin/Makefile +++ b/tests/test_hwtimer_spin/Makefile @@ -1,4 +1,4 @@ -# define project name +# define application name export PROJECT = test_hwtimer_spin # for easy switching of boards diff --git a/tests/test_irq/Makefile b/tests/test_irq/Makefile index 4ba01fed06..6b21e27f44 100644 --- a/tests/test_irq/Makefile +++ b/tests/test_irq/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_irq # # for easy switching of boards diff --git a/tests/test_nativenet/Makefile b/tests/test_nativenet/Makefile index 788af87e4d..2863737ec6 100644 --- a/tests/test_nativenet/Makefile +++ b/tests/test_nativenet/Makefile @@ -1,7 +1,7 @@ debug: CFLAGS += -g debug: CFLAGS += -DENABLE_DEBUG -# name of your project +# name of your application export PROJECT = test_nativenet # # for easy switching of boards diff --git a/tests/test_pnet/Makefile b/tests/test_pnet/Makefile index 652a395c4a..1955f1fa40 100644 --- a/tests/test_pnet/Makefile +++ b/tests/test_pnet/Makefile @@ -7,7 +7,7 @@ #### ../../boards for board definitions (if you have one or more) #### -# name of your project +# name of your application export PROJECT =test_pnet # for easy switching of boards diff --git a/tests/test_semaphore/Makefile b/tests/test_semaphore/Makefile index 4303b7324d..ab79a4a463 100644 --- a/tests/test_semaphore/Makefile +++ b/tests/test_semaphore/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_semaphore # for easy switching of boards diff --git a/tests/test_sha256/Makefile b/tests/test_sha256/Makefile index 9c1af5d308..3ddccf632d 100644 --- a/tests/test_sha256/Makefile +++ b/tests/test_sha256/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_sha256 # for easy switching of boards diff --git a/tests/test_shell/Makefile b/tests/test_shell/Makefile index 1328f4d732..f01336eb6a 100644 --- a/tests/test_shell/Makefile +++ b/tests/test_shell/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_shell # for easy switching of boards diff --git a/tests/test_shell/ReadMe.txt b/tests/test_shell/ReadMe.txt index a44c1216d8..d2f8288419 100644 --- a/tests/test_shell/ReadMe.txt +++ b/tests/test_shell/ReadMe.txt @@ -1,9 +1,9 @@ -This project shows how to use own or the system shell commands. In order to use +This application shows how to use own or the system shell commands. In order to use the system shell commands: 1. Additionally to the module: shell, shell_commands and posix, the module for the corresponding system command is to include, e.g. - module ps for the ps command (cf. the Makefile in the project root + module ps for the ps command (cf. the Makefile in the application root directory). 2. The shell must be initialized as follows: 2.1 shell_t sys_shell; diff --git a/tests/test_thread_basic/Makefile b/tests/test_thread_basic/Makefile index e39edab32a..0b7ef6799d 100644 --- a/tests/test_thread_basic/Makefile +++ b/tests/test_thread_basic/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_thread_basic # for easy switching of boards diff --git a/tests/test_thread_exit/Makefile b/tests/test_thread_exit/Makefile index d13255a52d..c000b5842d 100644 --- a/tests/test_thread_exit/Makefile +++ b/tests/test_thread_exit/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_thread_exit # for easy switching of boards diff --git a/tests/test_thread_msg/Makefile b/tests/test_thread_msg/Makefile index a31c5eed53..f96119e9c6 100644 --- a/tests/test_thread_msg/Makefile +++ b/tests/test_thread_msg/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_thread_msg export BOARD ?= native diff --git a/tests/test_vtimer_msg/Makefile b/tests/test_vtimer_msg/Makefile index 61cb511549..439cdd428d 100644 --- a/tests/test_vtimer_msg/Makefile +++ b/tests/test_vtimer_msg/Makefile @@ -1,4 +1,4 @@ -# name of your project +# name of your application export PROJECT = test_vtimer_msg # for easy switching of boards -- GitLab