Skip to content

Commit 3403d7a

Browse files
committed
Corrections in semantic.texi
* doc/misc/semantic.texi (Parser code, Tag handling) (Semanticdb Internals, Analyzer Internals, Tools): Fix file names according to what was actually imported from the original CEDET. (Bug#38451)
1 parent c574d27 commit 3403d7a

File tree

1 file changed

+50
-61
lines changed

1 file changed

+50
-61
lines changed

doc/misc/semantic.texi

Lines changed: 50 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,9 @@ to learn more about how @semantic{} works.
232232
* Semanticdb Internals:: Code used in the semantic database
233233
* Analyzer Internals:: Code used in the code analyzer
234234
* Tools:: Code used in user tools
235+
@ignore
235236
* Tests:: Code used for testing
237+
@end ignore
236238
@end menu
237239

238240
@node Parser code
@@ -246,44 +248,39 @@ The core infrastructure sets up buffers for parsing, and has all the
246248
core parsing routines. Most parsing routines are overloadable, so the
247249
actual implementation may be somewhere else.
248250

249-
@item semantic-edit.el
251+
@item semantic/edit.el
250252
Incremental reparse based on user edits.
251253

252-
@item semantic-grammar.el
254+
@item semantic/grammar.el
253255
@itemx semantic-grammar.wy
254256
Parser for the different grammar languages, and a major mode for
255257
editing grammars in Emacs.
256258

257-
@item semantic-lex.el
259+
@item semantic/lex.el
258260
Infrastructure for implementing lexical analyzers. Provides macros
259261
for creating individual analyzers for specific features, and a way to
260262
combine them together.
261263

262-
@item semantic-lex-spp.el
264+
@item semantic/lex-spp.el
263265
Infrastructure for a lexical symbolic preprocessor. This was written
264266
to implement the C preprocessor, but could be used for other lexical
265267
preprocessors.
266268

267-
@item bovine/bovine-grammar.el
268-
@itemx bovine/bovine-grammar-macros.el
269-
@itemx bovine/semantic-bovine.el
269+
@item semantic/grammar.el
270+
@itemx semantic/bovine/grammar.el
270271
The ``bovine'' grammar. This is the first grammar mode written for
271272
@semantic{} and is useful for simple creating simple parsers.
272273

273-
@item wisent/wisent.el
274-
@itemx wisent/bison-wisent.el
275-
@itemx wisent/semantic-wisent.el
276-
@itemx wisent/semantic-debug-grammar.el
274+
@item semantic/wisent.el
275+
@itemx semantic/wisent/wisent.el
276+
@itemx semantic/wisent/grammar.el
277277
A port of bison to Emacs. This infrastructure lets you create LALR
278278
based parsers for @semantic{}.
279279

280-
@item semantic-ast.el
281-
Manage Abstract Syntax Trees for parsers.
282-
283-
@item semantic-debug.el
280+
@item semantic/debug.el
284281
Infrastructure for debugging grammars.
285282

286-
@item semantic-util.el
283+
@item semantic/util.el
287284
Various utilities for manipulating tags, such as describing the tag
288285
under point, adding labels, and the all important
289286
@code{semantic-something-to-tag-table}.
@@ -298,42 +295,42 @@ function or variable. Tag handling is handled in several source
298295
files.
299296

300297
@table @file
301-
@item semantic-tag.el
298+
@item semantic/tag.el
302299
Basic tag creation, queries, cloning, binding, and unbinding.
303300

304-
@item semantic-tag-write.el
301+
@item semantic/tag-write.el
305302
Write a tag or tag list to a stream. These routines are used by
306303
@file{semanticdb-file.el} when saving a list of tags.
307304

308-
@item semantic-tag-file.el
305+
@item semantic/tag-file.el
309306
Files associated with tags. Goto-tag, file for include, and file for
310307
a prototype.
311308

312-
@item semantic-tag-ls.el
309+
@item semantic/tag-ls.el
313310
Language dependent features of a tag, such as parent calculation, slot
314311
protection, and other states like abstract, virtual, static, and leaf.
315312

316-
@item semantic-dep.el
313+
@item semantic/dep.el
317314
Include file handling. Contains the include path concepts, and
318315
routines for looking up file names in the include path.
319316

320-
@item semantic-format.el
317+
@item semantic/format.el
321318
Convert a tag into a nicely formatted and colored string. Use
322319
@code{semantic-test-all-format-tag-functions} to test different output
323320
options.
324321

325-
@item semantic-find.el
322+
@item semantic/find.el
326323
Find tags matching different conditions in a tag table.
327324
These routines are used by @file{semanticdb-find.el} once the database
328325
has been converted into a simpler tag table.
329326

330-
@item semantic-sort.el
327+
@item semantic/sort.el
331328
Sorting lists of tags in different ways. Includes sorting a plain
332329
list of tags forward or backward. Includes binning tags based on
333330
attributes (bucketize), and tag adoption for multiple references to
334331
the same thing.
335332

336-
@item semantic-doc.el
333+
@item semantic/doc.el
337334
Capture documentation comments from near a tag.
338335

339336
@end table
@@ -345,7 +342,7 @@ Capture documentation comments from near a tag.
345342
hairy problem to try and solve.
346343

347344
@table @file
348-
@item semanticdb.el
345+
@item semantic/db.el
349346
Defines a @dfn{database} and a @dfn{table} base class. You can
350347
instantiate these classes, and use them, but they are not persistent.
351348

@@ -363,26 +360,26 @@ you have a tree of directories and source files, it can find the root,
363360
and allow a tag-search to span all available databases in that
364361
directory hierarchy.
365362

366-
@item semanticdb-file.el
363+
@item semantic/db-file.el
367364
Provides a subclass of the basic table so that it can be saved to
368365
disk. Implements all the code needed to unbind/rebind tags to a
369366
buffer and writing them to a file.
370367

371-
@item semanticdb-el.el
368+
@item semantic/db-el.el
372369
Implements a special kind of @dfn{system} database that uses Emacs
373370
internals to perform queries.
374371

375-
@item semanticdb-ebrowse.el
372+
@item semantic/db-ebrowse.el
376373
Implements a system database that uses Ebrowse to parse files into a
377374
table that can be queried for tag names. Successful tag hits during a
378375
find causes @semantic{} to pick up and parse the reference files to
379376
get the full details.
380377

381-
@item semanticdb-find.el
378+
@item semantic/db-find.el
382379
Infrastructure for searching groups @semantic{} databases, and dealing
383380
with the search results format.
384381

385-
@item semanticdb-ref.el
382+
@item semantic/db-ref.el
386383
Tracks crossreferences. Cross references are needed when buffer is
387384
reparsed, and must alert other tables that any dependent caches may
388385
need to be flushed. References are in the form of include files.
@@ -398,45 +395,45 @@ start with @code{semantic-analyze-debug-assist}, then dive into some
398395
of these files.
399396

400397
@table @file
401-
@item semantic-analyze.el
398+
@item semantic/analyze.el
402399
The core analyzer for defining the @dfn{current context}. The
403400
current context is an object that contains references to aspects of
404401
the local context including the current prefix, and a tag list
405402
defining what the prefix means.
406403

407-
@item semantic-analyze-complete.el
404+
@item semantic/analyze/complete.el
408405
Provides @code{semantic-analyze-possible-completions}.
409406

410-
@item semantic-analyze-debug.el
407+
@item semantic/analyze/debug.el
411408
The analyzer debugger. Useful when attempting to get everything
412409
configured.
413410

414-
@item semantic-analyze-fcn.el
411+
@item semantic/analyze/fcn.el
415412
Various support functions needed by the analyzer.
416413

417-
@item semantic-ctxt.el
414+
@item semantic/ctxt.el
418415
Local context parser. Contains overloadable functions used to move
419416
around through different scopes, get local variables, and collect the
420417
current prefix used when doing completion.
421418

422-
@item semantic-scope.el
419+
@item semantic/scope.el
423420
Calculate @dfn{scope} for a location in a buffer. The scope includes
424421
local variables, and tag lists in scope for various reasons, such as
425422
C++ using statements.
426423

427-
@item semanticdb-typecache.el
424+
@item semantic/db-typecache.el
428425
The typecache is part of @code{semanticdb}, but is used primarily by
429426
the analyzer to look up datatypes and complex names. The typecache is
430427
bound across source files and builds a master lookup table for data
431428
type names.
432429

433-
@item semantic-ia.el
430+
@item semantic/ia.el
434431
Interactive Analyzer functions. Simple routines that do completion or
435432
lookups based on the results from the Analyzer. These routines are
436433
meant as examples for application writers, but are quite useful as
437434
they are.
438435

439-
@item semantic-ia-sb.el
436+
@item semantic/ia-sb.el
440437
Speedbar support for the analyzer, displaying context info, and
441438
completion lists.
442439

@@ -448,58 +445,49 @@ completion lists.
448445
These files contain various tools for users.
449446

450447
@table @file
451-
@item semantic-idle.el
448+
@item semantic/idle.el
452449
Idle scheduler for @semantic{}. Manages reparsing buffers after
453450
edits, and large work tasks in idle time. Includes modes for showing
454451
summary help and pop-up completion.
455452

456-
@item senator.el
453+
@item semantic/senator.el
457454
The @semantic{} navigator. Provides many ways to move through a
458455
buffer based on the active tag table.
459456

460-
@item semantic-decorate.el
457+
@item semantic/decorate.el
461458
A minor mode for decorating tags based on details from the parser.
462459
Includes overlines for functions, or coloring class fields based on
463460
protection.
464461

465-
@item semantic-decorate-include.el
462+
@item semantic/decorate/include.el
466463
A decoration mode for include files, which assists users in setting up
467464
parsing for their includes.
468465

469-
@item semantic-complete.el
466+
@item semantic/complete.el
470467
Advanced completion prompts for reading tag names in the minibuffer, or
471468
inline in a buffer.
472469

473-
@item semantic-imenu.el
470+
@item semantic/imenu.el
474471
Imenu support for using @semantic{} tags in imenu.
475472

476-
@item semantic-mru-bookmark.el
473+
@item semantic/mru-bookmark.el
477474
Automatic bookmarking based on tags. Jump to locations you've been
478475
before based on tag name.
479476

480-
@item semantic-sb.el
477+
@item semantic/sb.el
481478
Support for @semantic{} tag usage in Speedbar.
482479

483-
@item semantic-util-modes.el
480+
@item semantic/util-modes.el
484481
A bunch of small minor-modes that exposes aspects of the semantic
485482
parser state. Includes @code{semantic-stickyfunc-mode}.
486483

487-
@item document.el
488-
Create and update comments for tags.
489-
490-
@item semantic-adebug.el
491-
Extensions of @file{data-debug.el} for @semantic{}.
492-
493-
@item semantic-chart.el
484+
@item semantic/chart.el
494485
Draw some charts from stats generated from parsing.
495486

496-
497-
@item semantic-elp.el
498-
Profiler for helping to optimize the @semantic{} analyzer.
499-
500-
501487
@end table
502488

489+
@c These files seem to not have been imported from CEDET.
490+
@ignore
503491
@node Tests
504492
@section Tests
505493
@@ -519,6 +507,7 @@ Tests for the C parser's lexical pre-processor.
519507
Regression tests from the older Semantic 1.x API.
520508
521509
@end table
510+
@end ignore
522511

523512
@node Glossary
524513
@appendix Glossary

0 commit comments

Comments
 (0)