[Tinyos-2-commits] CVS: tinyos-2.x/tools/tinyos/ncc ncc.1, 1.1.2.3,
1.1.2.4
David Gay
idgay at users.sourceforge.net
Mon Jun 5 15:22:20 PDT 2006
Update of /cvsroot/tinyos/tinyos-2.x/tools/tinyos/ncc
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv18366
Modified Files:
Tag: tinyos-2_0_devel-BRANCH
ncc.1
Log Message:
point to nescc man page rather than try to replicate its description
Index: ncc.1
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tools/tinyos/ncc/Attic/ncc.1,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -C2 -d -r1.1.2.3 -r1.1.2.4
*** ncc.1 27 Dec 2005 21:55:40 -0000 1.1.2.3
--- ncc.1 5 Jun 2006 22:22:17 -0000 1.1.2.4
***************
*** 5,35 ****
.SH SYNOPSIS
! \fBncc\fR [\fB-target=\fIpc|mica|mica2|mica2dot|...\fR] [\fB-print-platforms\fR] [\fB-print-target\fR]
[\fB-board=\fImicasb|basicsb|micawb|...\fR]
! [\fB-tosdir=\fIdir\fR] [\fB-print-tosdir\fR] [\fB-nostdinc\fR]
! [\fB-fnesc-nido-tosnodes=\fIn\fR] [\fB-fnesc-cfile=\fIfile\fR] [\fB-fnesc-no-inline\fR]
! [\fB--version\fR] [\fB-fnesc-verbose\fR] [\fB-Wnesc-\fI...\fR]
! [\fB-fnesc-dump=\fIspecification\fR] [\fB-fnesc-dumpfile=\fIfile\fR]
! [\fB-fnesc-scheduler=\fIspecification\fR]
! [any gcc option] \fIfiles\fR...
.SH DESCRIPTION
! \fBncc\fR is an extension to \fBgcc\fR that knows how to compile nesC
! applications in the TinyOS environment. If invoked on regular C files, it
! behaves exactly like \fBgcc\fR. When invoked on a nesC component or
interface (\fB.nc\fR extension) file it compiles and links (except if the
usual \fB-c\fR, \fB-S\fR, \fB-E\fR or \fB-fsyntax-only\fR options are used)
that component with the other files specified on the command line.
.SH OPTIONS
! \fBncc\fR accepts all \fBgcc\fR options, and some additional TinyOS
! and nesC specific options:
.TP
\fB-target=\fIX\fR
Specify the target architecture for this compilation. If \fB-tossim\fR is
also specified, the compilation uses the tossim environment and produces a
! locally executable file. The default target is \fBmica\fR, the possible
! targets are set by the TinyOS distribution (see the \fBtos/platforms\fR
! directory). A platform that is not in the TinyOS distribution can be used
if its directory is specified with an explicit -I directive (the platform
name is taken from the directory's name, platform directories are
--- 5,38 ----
.SH SYNOPSIS
! \fBncc\fR [\fB-target=\fIpc|mica|mica2|mica2dot|...\fR] [\fB-tossim\fR]
[\fB-board=\fImicasb|basicsb|micawb|...\fR]
! [\fB-tosdir=\fIdir\fR] [\fB-nostdinc\fR]
! [\fB--version\fR] [\fB-print-tosdir\fR] [\fB-print-platforms\fR] [\fB-print-target\fR]
! [any nescc option] [any gcc option] \fIfiles\fR...
.SH DESCRIPTION
! \fBncc\fR is an extension to \fBnescc\fR that knows how to compile nesC
! applications for a TinyOS environment. If invoked on regular C files, it
! behaves like \fBgcc\fR. When invoked on a nesC component or
interface (\fB.nc\fR extension) file it compiles and links (except if the
usual \fB-c\fR, \fB-S\fR, \fB-E\fR or \fB-fsyntax-only\fR options are used)
that component with the other files specified on the command line.
+
+ \fBncc\fR just invokes \fBnescc\fR with extra options based on the
+ selected platform and sensorboard(s). And \fBnescc\fR itself just
+ invokes \fBgcc\fR. Thus, for a full understanding of possible \fBncc\fR
+ options you should read the \fBnescc\fR and \fBgcc\fR man pages.
.SH OPTIONS
! \fBncc\fR accepts all \fBgcc\fR and \fBnescc\fR options, and some additional
! TinyOS specific options:
.TP
\fB-target=\fIX\fR
Specify the target architecture for this compilation. If \fB-tossim\fR is
also specified, the compilation uses the tossim environment and produces a
! locally executable file. The default target is specified in the
! \fB.default-platform\fR file in your TinyOS directory (see \fB-tosdir\fR
! option), and defaults to \fBmica\fR if that file is absent. A platform that
! is not in the TinyOS distribution can be used
if its directory is specified with an explicit -I directive (the platform
name is taken from the directory's name, platform directories are
***************
*** 45,49 ****
\fB-tossim\fR
Compile for the TOSSIM environment rather than a native platform. Every
! directory in the search path will be copied, with the first copy having
\fB/sim\fR appended to it.
.TP
--- 48,52 ----
\fB-tossim\fR
Compile for the TOSSIM environment rather than a native platform. Every
! directory in the search path will be duplicated, with the first copy having
\fB/sim\fR appended to it.
.TP
***************
*** 73,161 ****
file).
.TP
- \fB-fnesc-nido-tosnodes=\fIn\fR
- Specify the maximum number of nodes that can be simulated in the tossim
- (\fBpc\fR target) environment.
- .TP
- \fB-fnesc-no-inline\fR
- Disabled the automatic inlining of all small functions, and of all functions
- with a single call site.
- .TP
- \fB-fnesc-cfile=\fIfile\fR
- Specify a file in which to save the C code generated when compiling a
- component. Note: if you specify two components on the command line, then
- the C code from the second one will overwrite the C code from the first.
- .TP
\fB--version\fR
Print the version of \fBncc\fR, \fBnescc\fR and of the gcc compiler
used for the selected target.
- .TP
- \fB-fnesc-include=\fIheader-file\fR
- Include the specified file before compiling a nesC component. Behaves
- as if \fBincludes \fIheader-file\fB;\fR was included at the start of
- that component.
- .TP
- \fB-fnesc-dump=\fIspecification\fR
- Output information on the compiled programs structure, and in particular
- its user-specified attributes. For more details, see the separate nesC
- dump documentation.
- .TP
- \fB-fnesc-dumpfile=\fIfile\fR
- Where to output the information requested by \fB-fnesc-dump\fR. Defaults to
- stdout.
- .TP
- \fB-fnesc-verbose\fR
- Be more verbose than \fB-v\fR.
- .TP
- \fB-fnesc-scheduler=\fIcomponent\fR,\fIunique-string\fR,\fIinterface-name\fR,\fIinterface-definition\fR,\fIrun-event\fR,\fIpost-command\fR
- By default, nesC compiles uses of \fBtask void \fItaskname\fB() ...\fR to
- \fBvoid \fItaskname\fB()\fR, and \fBpost \fItaskname()\fR to
- \fBTOS_post(\fItaskname\fB)\fR.
-
- With this option, each task gets its own \fIinterface-definition\fR
- interface, the task implementation is transformed into a \fIrun-event\fR
- event and posts becomes a call to the \fIpost-command\fR command. This
- per-task interface is automatically connected to the parameterised
- \fIinterface-name\fR interface of scheduler component \fIcomponent\fR. The
- parameter id for the connection is chosen with
- \fBunique("\fIunique-string\fB")\fR.
- .PP
- There are a number of warnings specific to nesC, specified with
- \fB-Wnesc-\fR (all these warnings are off by
- default):
- .TP
- \fB-Wnesc-fnptr\fR
- Warn when function pointers are used (use of function pointers is
- deprecated in nesC and leads to inaccurate data race detection).
- .TP
- \fB-Wnesc-async\fR
- Warn when interrupt handlers call commands or events not annotated with
- \fBasync\fR.
- .TP
- \fB-Wnesc-data-race\fR
- Warn about potential data races.
- .TP
- \fB-Wnesc-combine\fR
- Warn when configuration wiring leads to "fan-out" and the function return
- type does not have a combining function defined.
- .TP
- \fB-Wnesc-docstring\fR
- Warn when unexpected documentation strings (starting with \fB/**\fR) are
- seen.
- .TP
- \fB-Wnesc-all\fR
- Turns on \fB-Wnesc-fnptr\fR, \fB-Wnesc-async\fR, \fB-Wnesc-combine\fR
- and\fB-Wnesc-data-race\fR.
- .TP
- \fB-Wnesc-error\fR
- Turns the \fB-Wnesc-fnptr\fR, \fB-Wnesc-async\fR, \fB-Wnesc-combine\fR and
- \fB-Wnesc-data-race\fR warnings into errors.
- .PP
- When compiling a nesC component, the nesC compiler recognizes the gcc C
- language (\fB-f...\fR) and warning (\fB-W...\fR) options. The \fB-S\fR,
- \fB-c\fR and \fB-o\fR options work as usual, the \fB-x\fR option accepts
- \fBnesc\fR. The \fB-v\fR option causes the nesC compiler to print out the
- paths of all components and interfaces that are loaded. Directories can be
- added to nesC\fRs search path with \fB-I\fR (see the search path discussion
- below).
.SH EXAMPLES
--- 76,82 ----
***************
*** 206,213 ****
.SH PREPROCESSOR SYMBOLS
! \fBncc\fR defines the following preprocessor symbols:
! .TP
! \fBNESC\fR (since v1.1)
! set to XYZ where x.yz is the nesC version
.TP
\fBPLATFORM_\fItarget\fR
--- 127,132 ----
.SH PREPROCESSOR SYMBOLS
! In addition to the preprocessor symbols defined by \fBgcc\fR and
! \fBnescc\fR, \fBncc\fR defines:
.TP
\fBPLATFORM_\fItarget\fR
***************
*** 223,230 ****
If the \fB-tosdir=\fIdir\fR option is not used, the \fBTOSDIR\fR
environment variable specifies the location of TinyOS.
- .TP
- .B NESCPATH
- A colon separated list of additional search directories for
- nesC components.
.SH SEE ALSO
--- 142,145 ----
***************
*** 238,245 ****
prefer to use \fBnescc\fR (see the source code of ncc and nescc for
details).
-
- The warnings for the new nesC 1.1 features (see \fB-Wnesc-all\fR) are off
- by default to increase compatibility with nesC 1.0 code. To match the
- language specification in the nesC 1.1 reference manual, you should compile
- with \fB-Wnesc-all\fR and \fB-Wnesc-error\fR. These options will become the
- default in future releases.
--- 153,154 ----
More information about the Tinyos-2-commits
mailing list