From 35968df0f54532dd1d1b4daf6838db6c70e00234 Mon Sep 17 00:00:00 2001 From: Philippe Coval Date: Sat, 27 Aug 2016 16:53:16 +0200 Subject: [PATCH] doc: Fix some typos in scons_script_how_to.txt Maybe this file worth to be migrated to iotivity wiki in a scons page Change-Id: I288da1273621a48add047993506ed40c107363ab Signed-off-by: Philippe Coval Reviewed-on: https://gerrit.iotivity.org/gerrit/11077 Tested-by: jenkins-iotivity Reviewed-by: Ziran Sun (cherry picked from commit da851aa0583bb1fcccfa634de8b61ee815fbdbd8) Reviewed-on: https://gerrit.iotivity.org/gerrit/12109 --- scons_script_how_to.txt | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/scons_script_how_to.txt b/scons_script_how_to.txt index 1b9e7f3..4203602 100644 --- a/scons_script_how_to.txt +++ b/scons_script_how_to.txt @@ -41,7 +41,7 @@ CPPPATH: The directories that the preprocessor will search for include headers. CPPDEFINES: Platform independent specification of C preprocessor definitions. Note: CPPPATH and CPPDEFINES is common for all compiler. But others are -compiler specific, when change the key value, it may requried to specify the +compiler specific, when change the key value, it may required to specify the target platform(actually the compiler). e.g. @@ -82,7 +82,7 @@ In above example, 'target_os' is used. How to get it? User can build IoTivity project on Linux / Windows / MAC OSX for various targets(Linux, Tizen, Android, Arduino, Windows, MAC OSX, IOS ...). Most -platform specific configures have been done in the common scripts which are in +platform specific configurations have been done in the common scripts which are in build_common. The common scripts prepare an environment named 'env' with target platform specific configuration. @@ -105,7 +105,7 @@ or env['XXX'] XXX is the information name, below are the extra information added by IoTivity -common scrirpts: +common scripts: BUILD_DIR: the path of the build directory, all output are in this directory SRC_DIR: the path of the top directory of the source code RELEASE: build type, boolean. True - release build, False - debug build @@ -136,7 +136,7 @@ PrintTargets(): print all target names in the help information. AppendTarget(name, target = None): add a target name into targets list, when use PrintTargets, the target name will be print # @param name - the name of the target(s)(user defined name) -# @param target - Final binary, file(s) etc genereted after build. +# @param target - Final binary, file(s) etc generated after build. InstallTarget(files, name): it takes the same action as AppendTarget, besides, it installs the 'files' to BUILD_DIR. @@ -149,7 +149,7 @@ will be auto added to the environment and the library will be built and linked into the final binary. CreateBin(bin, src): For Arduino, after build the program, it's required to -be converted into specific format (e.g .hex). This function will genearate the +be converted into specific format (e.g .hex). This function will generate the required .hex (and .eep if target arch is avr) file from 'bin'. UploadHelp(): For different board, the upload command line is different, this @@ -171,7 +171,7 @@ Download(target, url): Download source code from URL 'url' and save as 'target'. # @param target - the name of the source code package to be saved as # @param url - the URL from which to download the source code -Configure(cwd, cmd): Run configure command(such as: boostrap, configure etc. +Configure(cwd, cmd): Run configure command(such as: bootstrap, configure etc. usually it's done before build a library) # @param cwd - the work directory, full path or relative path to the directory where the library build script in @@ -188,7 +188,7 @@ Install_lib(lib): Install library binaries to /deps//lib/