X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/f7ff1b0f0792f1f870778404531e68e77832c4a1..7e09ef09a479731d01b1ca46e94ddadd73ac98e3:/doc/misc/sem-user.texi diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi index b17f1ab7e9..2d9eac2dd7 100644 --- a/doc/misc/sem-user.texi +++ b/doc/misc/sem-user.texi @@ -1,13 +1,7 @@ -@c This file is included by semantic.texi - -@c Copyright (C) 1999-2005, 2007, 2009-2011 Free Software Foundation, Inc. - -@c Permission is granted to copy, distribute and/or modify this -@c document under the terms of the GNU Free Documentation License, -@c Version 1.3 or any later version published by the Free Software -@c Foundation; with no Invariant Sections, no Front-Cover Texts, and -@c no Back-Cover Texts. A copy of the license is included in the -@c section entitled ``GNU Free Documentation License''. +@c This is part of the Semantic manual. +@c Copyright (C) 1999-2005, 2007, 2009-2015 Free Software Foundation, +@c Inc. +@c See file semantic.texi for copying conditions. You can begin using @semantic{} by enabling Semantic mode, a global minor mode: type @kbd{M-x semantic-mode}, or open the @samp{Tools} @@ -31,7 +25,7 @@ File,,,emacs,Emacs manual}. * Analyzer:: Semantic tools for analyzing code. * Speedbar:: Using @semantic{} with the Speedbar. * SymRef:: Interface to symbol reference tools. -* MRU Bookmarks:: Managing tag ``bookmarks''. +* MRU Bookmarks:: Managing tag "bookmarks". * Sticky Func Mode:: Showing declarations in the header line. * Highlight Func Mode:: Highlight the current function declaration. * Tag Decoration Mode:: Minor mode to decorate tags. @@ -59,7 +53,7 @@ minor modes. The variable @code{semantic-default-submodes} determines which auxiliary modes are enabled; the defaults are SemanticDB mode (@pxref{SemanticDB}) and Global Semantic Idle Scheduler mode (@pxref{Idle Scheduler}). You can also toggle the auxiliary minor -modes separately, using their mode functions (e.g. @kbd{M-x +modes separately, using their mode functions (e.g., @kbd{M-x semanticdb-minor-mode}), or via the @samp{Development} menu. The various auxiliary minor modes are described in the following sections. @@ -105,7 +99,7 @@ valid mode symbols are: Semantic mode provides a number of commands for navigating, querying, and editing source code in a language-aware manner. These commands generally act on @dfn{tags}, which are the source-code units deemed -``important'' by the present programming language (e.g. functions in +``important'' by the present programming language (e.g., functions in the C programming language). These commands may be used in any buffer that has been parsed by @@ -176,7 +170,7 @@ Copy the current tag into a register kill it as well. This allows you to insert or jump to that tag with the usual register commands. @xref{Registers,,,emacs,Emacs manual}. -@item \C-c , @kbd{up} +@item C-c , @kbd{up} Transpose the current tag with the previous one (@code{senator-transpose-tags-up}). @@ -277,7 +271,7 @@ variable. This allows SemanticDB to save tag caches in directories controlled by them. @end defvar -@deffn Option semanticdb-save-database-hooks +@deffn Option semanticdb-save-database-functions Abnormal hook run after a database is saved. Each function is called with one argument, the object representing the database recently written. @@ -382,7 +376,7 @@ them yourself. @deffn Option semanticdb-project-roots The value of this variable is a list of directories (strings) that are project roots. All subdirectories of a project root are considered -part of the same project. This variable can be overriden by +part of the same project. This variable can be overridden by @code{semanticdb-project-root-functions}. @end deffn @@ -422,11 +416,11 @@ Customize the system include path for the current major mode (or @var{mode}). @end deffn -@defun semanticdb-implied-include-tags +@defvar semanticdb-implied-include-tags Include tags implied for all files of a given mode. You can set this variable with @code{defvar-mode-local} for a particular mode so that any symbols that exist for all files for that mode are included. -@end defun +@end defvar @c @xref{Search Optimization}, for more information on include paths. @@ -489,9 +483,9 @@ for them once, which will be used over and over for tools such as summary-mode, or the analyzer. @deffn Command semanticdb-create-ebrowse-database dir -Create an @var{ebrowse} database for directory @var{dir}. -The database file is stored in ~/.semanticdb, or whichever directory -is specified by @code{semanticdb-default-system-save-directory}. +Create an Ebrowse database for directory @var{dir}. The database file +is stored in ~/.semanticdb, or whichever directory is specified by +@code{semanticdb-default-system-save-directory}. @end deffn @node Idle Scheduler @@ -547,7 +541,7 @@ reparsed regardless of their size. @end deffn @deffn Option semantic-idle-scheduler-no-working-message -If non-@code{nil}, disable display of working messages whie reparsing. +If non-@code{nil}, disable display of working messages while reparsing. @end deffn @deffn Option semantic-idle-scheduler-working-in-modeline-flag @@ -608,7 +602,7 @@ of parsing. The default is @code{t}. @node Debugging Idle Time Issues @subsection Debugging Idle Time Issues -If you see an error signalled during idle time, it could be an +If you see an error signaled during idle time, it could be an indication of a more serious issue elsewhere. It is not enough to enable @code{debug-on-error}, because the idle scheduler inhibits the debugger. Instead, use the following commands to debug the error: @@ -880,7 +874,7 @@ command, like this: @end example @end defun -These commands are often more accurate than than the @code{find-tag} +These commands are often more accurate than the @code{find-tag} command (@pxref{Tags,,,emacs,Emacs manual}), because the Semantic Analyzer is context-sensitive. @@ -909,12 +903,12 @@ at a given buffer position. The return value is an EIEIO object describing the context at @var{pos} (@pxref{Top,,,eieio,EIEIO manual}). -When called interactively, this displays a @samp{*Semantic Context +When called interactively, this displays a @file{*Semantic Context Analysis*} buffer containing a summary of the context at point. @end deffn @noindent -The Prefix section of the @samp{*Semantic Context Analysis*} buffer +The Prefix section of the @file{*Semantic Context Analysis*} buffer lists the tags based on the text at point. If it shows only a simple string, the Semantic was unable to identify what the data type was. @@ -989,7 +983,7 @@ If your symbol should be in the scope, but you cannot find it, then you may have found a language support bug in the local-variable parser, or using statement parser. -Calling @kbd{M-x bovinte} should force a reset on the scope in case +Calling @kbd{M-x bovinate} should force a reset on the scope in case there is merely some bad state. @example @@ -1020,7 +1014,7 @@ fully qualified names. You can examine the typecache with @kbd{M-x semanticdb-typecache-dump}. If your data types are not in the typecache, there may be some parsing -error or other bug. Calling @kbd{M-x bovinte} should force a reset on +error or other bug. Calling @kbd{M-x bovinate} should force a reset on the typecache in case there is merely some bad state. @example @@ -1309,7 +1303,7 @@ You can create new types of decorations using the following function: Define a new decoration style with @var{name}. @var{doc} is a documentation string describing the decoration style @var{name}. It is appended to auto-generated doc strings. -An Optional list of @var{flags} can also be specified. Flags are: +An optional list of @var{flags} can also be specified. Flags are: @code{:enabled} - specify the default enabled value for @var{name}.