Skip to content

Commit

Permalink
Big rename of doc anchors.
Browse files Browse the repository at this point in the history
  • Loading branch information
grafikrobot committed Jan 19, 2025
1 parent 5c2fa0f commit 3a203bc
Show file tree
Hide file tree
Showing 100 changed files with 554 additions and 549 deletions.
10 changes: 5 additions & 5 deletions doc/src/abstract-target.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[bbv2.reference.class.abstract-target]]
[[b2.reference.class.abstract-target]]
= Class abstract-target

Base class for all abstract targets.
Expand All @@ -16,7 +16,7 @@ class abstract-target {
----

Classes derived from
link:#bbv2.reference.class.abstract-target[abstract-target]:
link:#b2.reference.class.abstract-target[abstract-target]:

* project-target
* main-target
Expand All @@ -28,7 +28,7 @@ link:#bbv2.reference.class.abstract-target[abstract-target]:
`name`::
The name of the target in the Jamfile.
`project`::
The link:#bbv2.reference.class.project-target[project] to which this
The link:#b2.reference.class.project-target[project] to which this
target belongs.

2. `rule name ( )`
Expand All @@ -37,7 +37,7 @@ Returns the name of this target.

3. `rule project ( )`
+
Returns the link:#bbv2.reference.class.project-target[project] for this
Returns the link:#b2.reference.class.project-target[project] for this
target.

4. `rule location ( )`
Expand All @@ -48,7 +48,7 @@ Returns the location where the target was declared.
+
Returns a user-readable name for this target.

6. [[bbv2.reference.class.abstract-target.generate]] `rule generate ( property-set )`
6. [[b2.reference.class.abstract-target.generate]] `rule generate ( property-set )`
+
Generates virtual targets for this abstract target using the specified
properties, unless a different value of some feature is required by the
Expand Down
38 changes: 19 additions & 19 deletions doc/src/architecture.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[bbv2.arch]]
[[b2.arch]]
B2 v2 architecture
---------------------------

This document is work-in progress. Do not expect much from it yet.

[[bbv2.arch.overview]]
[[b2.arch.overview]]
Overview
--------

Expand All @@ -18,7 +18,7 @@ functionality. It mostly allows declaring specific kinds of main
targets, as well as registering available tools, which are then used
when creating the dependency graph.

[[bbv2.arch.build]]
[[b2.arch.build]]
The build layer
---------------

Expand Down Expand Up @@ -55,7 +55,7 @@ instance, the `actualize` method is called to setup nodes and updating
actions in the dependency graph kept inside B2 engine. This
dependency graph is then updated, which runs necessary commands.
[[bbv2.arch.build.metatargets]]
[[b2.arch.build.metatargets]]
Metatargets
~~~~~~~~~~~

Expand Down Expand Up @@ -106,7 +106,7 @@ to eliminate all such subclasses at the moment.
Note that the `build/targets.jam` file contains an UML diagram which
might help.
[[bbv2.arch.build.virtual]]
[[b2.arch.build.virtual]]
Virtual targets
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -141,7 +141,7 @@ functionality is part of the "toolset" module.
Note that the `build/virtual-targets.jam` file contains an UML diagram
which might help.
[[bbv2.arch.build.properties]]
[[b2.arch.build.properties]]
Properties
~~~~~~~~~~
Expand All @@ -154,13 +154,13 @@ caching for all operations, so most work is avoided. The
`property-set.create` is the factory function used to create instances
of the `property-set` class.
[[bbv2.arch.tools]]
[[b2.arch.tools]]
The tools layer
---------------
Write me!
[[bbv2.arch.targets]]
[[b2.arch.targets]]
Targets
-------
Expand All @@ -179,41 +179,41 @@ constructed from file targets. User has no way to create file targets
but can specify rules for detecting source file types, as well as rules
for transforming between file targets of different types. That
information is used in constructing the final dependency graph, as
described in the link:#bbv2.arch.depends[next section]. **Note:**File
described in the link:#b2.arch.depends[next section]. **Note:**File
targets are not the same entities as Jam targets; the latter are created
from file targets at the latest possible moment. *Note:*"File target" is
an originally proposed name for what we now call virtual targets. It is
more understandable by users, but has one problem: virtual targets can
potentially be "phony", and not correspond to any file.
[[bbv2.arch.depends]]
[[b2.arch.depends]]
Dependency scanning
-------------------
Dependency scanning is the process of finding implicit dependencies,
like "#include" statements in {CPP}. The requirements for correct
dependency scanning mechanism are:
* link:#bbv2.arch.depends.different-scanning-algorithms[Support for
* link:#b2.arch.depends.different-scanning-algorithms[Support for
different scanning algorithms]. {CPP} and XML have quite different syntax
for includes and rules for looking up the included files.
* link:#bbv2.arch.depends.same-file-different-scanners[Ability to scan
* link:#b2.arch.depends.same-file-different-scanners[Ability to scan
the same file several times]. For example, a single {CPP} file may be
compiled using different include paths.
* link:#bbv2.arch.depends.dependencies-on-generated-files[Proper
* link:#b2.arch.depends.dependencies-on-generated-files[Proper
detection of dependencies on generated files.]
* link:#bbv2.arch.depends.dependencies-from-generated-files[Proper
* link:#b2.arch.depends.dependencies-from-generated-files[Proper
detection of dependencies from a generated file.]
[[bbv2.arch.depends.different-scanning-algorithms]]
[[b2.arch.depends.different-scanning-algorithms]]
Support for different scanning algorithms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Different scanning algorithm are encapsulated by objects called
"scanners". Please see the "scanner" module documentation for more
details.
[[bbv2.arch.depends.same-file-different-scanners]]
[[b2.arch.depends.same-file-different-scanners]]
Ability to scan the same file several times
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -243,7 +243,7 @@ a.cpp (installed copy) <--(copy) ----------------------- a.cpp (no scanner)
a.verbose --------------------------------+
....
[[bbv2.arch.depends.dependencies-on-generated-files]]
[[b2.arch.depends.dependencies-on-generated-files]]
Proper detection of dependencies on generated files.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -347,7 +347,7 @@ seem to be causing any problems in practice.
For target types other than {CPP}, adding of include paths must be
implemented anew.
[[bbv2.arch.depends.dependencies-from-generated-files]]
[[b2.arch.depends.dependencies-from-generated-files]]
Proper detection of dependencies from generated files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -441,7 +441,7 @@ Types
A file target can be given a type, which determines what transformations
can be applied to the file. The `type.register` rule declares new types.
File type can also be assigned a scanner, which is then used to find
implicit dependencies. See "link:#bbv2.arch.depends[dependency
implicit dependencies. See "link:#b2.arch.depends[dependency
scanning]".
Target paths
Expand Down
14 changes: 7 additions & 7 deletions doc/src/basic-target.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[bbv2.reference.class.basic-target]]
[[b2.reference.class.basic-target]]
= Class basic-target

[source]
----
class basic-target : abstract-target {
rule __init__ ( name : project : sources * : requirements * : default-build * : usage-requirements * )
rule __init__ ( name : project : sources * : requirements * : default-build * : usage-requirements * )
rule generate ( property-set )
rule construct ( name : source-targets * : property-set )
Expand All @@ -26,23 +26,23 @@ and handles generation of those dependency targets.
`name`::
The name of the target
`project`::
The link:#bbv2.reference.class.project-target[project] in which the
The link:#b2.reference.class.project-target[project] in which the
target is declared.

2. [[bbv2.reference.class.basic-target.generate]] `rule generate ( property-set )`
2. [[b2.reference.class.basic-target.generate]] `rule generate ( property-set )`
+
Overrides
link:#bbv2.reference.class.abstract-target.generate[abstract-target.generate].
link:#b2.reference.class.abstract-target.generate[abstract-target.generate].
Determines final build properties, generates sources, and calls
link:#bbv2.reference.class.basic-target.construct[construct]. This
link:#b2.reference.class.basic-target.construct[construct]. This
method should not be overridden.
+
On success, returns:
+
* a property-set with the usage requirements to be applied to dependents
* a list of produced virtual targets, which may be empty.

3. [[bbv2.reference.class.basic-target.construct]] `rule construct ( name : source-targets * : property-set )`
3. [[b2.reference.class.basic-target.construct]] `rule construct ( name : source-targets * : property-set )`
+
Constructs virtual targets for this abstract target. Returns a
usage-requirements property-set and a list of virtual targets. Should be
Expand Down
2 changes: 1 addition & 1 deletion doc/src/bjam.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[bbv2.jam]]
[[b2.jam]]
= Boost.Jam Documentation

____
Expand Down
14 changes: 7 additions & 7 deletions doc/src/debug.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[bbv2.util]]
[[b2.util]]
= Utilities

[[bbv2.util.debugger]]
[[b2.util.debugger]]
== Debugger

[[bbv2.util.debugger.overview]]
[[b2.util.debugger.overview]]
=== Overview

B2 comes with a debugger for Jamfiles. To run the debugger,
Expand All @@ -21,7 +21,7 @@ Breakpoint 1, gcc.init ( ) at /usr/share/b2/tools/gcc.jam:74
(b2db) quit
....

[[bbv2.util.debugger.running]]
[[b2.util.debugger.running]]
=== Running the Program

The `run` command is used to start a new `b2` subprocess for debugging.
Expand All @@ -37,7 +37,7 @@ until the current function returns.

The `kill` command terminates the current child immediately.

[[bbv2.util.debugger.break]]
[[b2.util.debugger.break]]
=== Breakpoints

Breakpoints are set using the `break` command. The location of the
Expand Down Expand Up @@ -73,7 +73,7 @@ Deleted breakpoint 1
(b2db) delete 2
....

[[bbv2.util.debugger.stack]]
[[b2.util.debugger.stack]]
=== Examining the Stack

The `backtrace` command will print a summary of every frame on the
Expand All @@ -88,7 +88,7 @@ The `print` command can be used to show the value of an expression.
Jamfile.jam
....

[[bbv2.util.debugger.misc]]
[[b2.util.debugger.misc]]
=== Miscellaneous Commands

`quit` exits the debugger. `help` describes the available commands.
Loading

0 comments on commit 3a203bc

Please sign in to comment.