kamikazechaser/cic-internal-integration
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

refactor: Make texinfo docs buildable with makeinfo <6.0

Browse Source
This commit is contained in:
Louis Holbrook 2021-10-26 20:01:19 +00:00
parent 8250b15d32
commit e3acc1757a
13 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
apps/cic-eth/doc/texinfo/accounts.texi
View File

@ -1,4 +1,3 @@
@node cic-eth-accounts
@section Accounts @section Accounts
Accounts are private keys in the signer component keyed by "addresses," a one-way transformation of a public key. Data can be signed by using the account as identifier for corresponding RPC requests. Accounts are private keys in the signer component keyed by "addresses," a one-way transformation of a public key. Data can be signed by using the account as identifier for corresponding RPC requests.

4
apps/cic-eth/doc/texinfo/admin.texi
View File

@ -1,4 +1,4 @@
@node cic-eth-appendix-system-maintenance @anchor{cic-eth-appendix-system-maintenance}
@appendix Admin API @appendix Admin API
The admin API is still in an early stage of refinement. User friendliness can be considerably improved. The admin API is still in an early stage of refinement. User friendliness can be considerably improved.
@ -33,7 +33,7 @@ Get the current state of a lock
@appendixsection tag_account @appendixsection tag_account
Associate an identifier with an account address (@xref{cic-eth system accounts}) Associate an identifier with an account address (@xref{cic-eth-system-accounts})
@appendixsection have_account @appendixsection have_account

2
apps/cic-eth/doc/texinfo/chains.texi
View File

@ -1,4 +1,4 @@
@node cic-eth-appendix-task-chains @anchor{cic-eth-appendix-task-chains}
@appendix Task chains @appendix Task chains
TBC - explain here how to generate these chain diagrams TBC - explain here how to generate these chain diagrams

1
apps/cic-eth/doc/texinfo/configuration.texi
View File

@ -1,4 +1,3 @@
@node cic-eth configuration
@section Configuration @section Configuration
Configuration parameters are grouped by configuration filename. Configuration parameters are grouped by configuration filename.

1
apps/cic-eth/doc/texinfo/content.texi
View File

@ -1,3 +1,4 @@
@node cic-eth
@top cic-eth @top cic-eth
@include dependencies.texi @include dependencies.texi

1
apps/cic-eth/doc/texinfo/dependencies.texi
View File

@ -1,4 +1,3 @@
@node cic-eth-dependencies
@section Dependencies @section Dependencies
This application is written in Python 3.8. It is tightly coupled with @code{python-celery}, which provides the task worker ecosystem. It also uses @code{SQLAlchemy} which provides useful abstractions for persistent storage though SQL, and @code{alembic} for database schema migrations. This application is written in Python 3.8. It is tightly coupled with @code{python-celery}, which provides the task worker ecosystem. It also uses @code{SQLAlchemy} which provides useful abstractions for persistent storage though SQL, and @code{alembic} for database schema migrations.

2
apps/cic-eth/doc/texinfo/incoming.texi
View File

@ -1,4 +1,4 @@
@node cic-eth-incoming @anchor{cic-eth-incoming}
@section Incoming transactions @section Incoming transactions
All transactions in mined blocks will be passed to a selection of plugin filters to the @code{chainsyncer} component. Each of these filters are individual python module files in @code{cic_eth.runnable.daemons.filters}. This section describes their function. All transactions in mined blocks will be passed to a selection of plugin filters to the @code{chainsyncer} component. Each of these filters are individual python module files in @code{cic_eth.runnable.daemons.filters}. This section describes their function.

1
apps/cic-eth/doc/texinfo/interacting.texi
View File

@ -1,4 +1,3 @@
@node cic-eth-interacting
@section Interacting with the system @section Interacting with the system
The API to the @var{cic-eth} component is a proxy for executing @emph{chains of Celery tasks}. The tasks that compose individual chains are documented in @ref{cic-eth-appendix-task-chains,the Task Chain appendix}, which also describes a CLI tool that can generate graph representationso of them. The API to the @var{cic-eth} component is a proxy for executing @emph{chains of Celery tasks}. The tasks that compose individual chains are documented in @ref{cic-eth-appendix-task-chains,the Task Chain appendix}, which also describes a CLI tool that can generate graph representationso of them.

1
apps/cic-eth/doc/texinfo/outgoing.texi
View File

@ -1,4 +1,3 @@
@node cic-eth-outgoing
@section Outgoing transactions @section Outgoing transactions
@strong{Important! A pre-requisite for proper functioning of the component is that no other agent is sending transactions to the network for any of the keys in the keystore.} @strong{Important! A pre-requisite for proper functioning of the component is that no other agent is sending transactions to the network for any of the keys in the keystore.}

1
apps/cic-eth/doc/texinfo/services.texi
View File

@ -1,4 +1,3 @@
@node cic-eth-services
@section Services @section Services
There are four daemons that together orchestrate all of the aforementioned recipes. This section will provide a high level description of them. There are four daemons that together orchestrate all of the aforementioned recipes. This section will provide a high level description of them.

2
apps/cic-eth/doc/texinfo/system.texi
View File

@ -1,10 +1,10 @@
@node cic-eth system accounts
@section System initialization @section System initialization
When the system starts for the first time, it is locked for any state change request other than account creation@footnote{Specifically, the @code{INIT}, @code{SEND} and @code{QUEUE} lock bits are set.}. These locks should be @emph{reset} once system initialization has been completed. Currently, system initialization only involves creating and tagging required system accounts, as specified below. When the system starts for the first time, it is locked for any state change request other than account creation@footnote{Specifically, the @code{INIT}, @code{SEND} and @code{QUEUE} lock bits are set.}. These locks should be @emph{reset} once system initialization has been completed. Currently, system initialization only involves creating and tagging required system accounts, as specified below.
See @ref{cic-eth-locking,Locking} and @ref{cic-eth-tools-ctrl,ctrl in Tools} for details on locking. See @ref{cic-eth-locking,Locking} and @ref{cic-eth-tools-ctrl,ctrl in Tools} for details on locking.
@anchor{cic-eth-system-accounts}
@subsection System accounts @subsection System accounts
Certain accounts in the system have special roles. These are defined by @emph{tagging} certain accounts addresses with well-known identifiers. Certain accounts in the system have special roles. These are defined by @emph{tagging} certain accounts addresses with well-known identifiers.

3
apps/cic-eth/doc/texinfo/tools.texi
View File

@ -1,4 +1,3 @@
@node cic-eth-tools
@section Tools @section Tools
A collection of CLI tools have been provided to help with diagnostics and other administrative tasks. These use the same configuration infrastructure as the daemons. A collection of CLI tools have been provided to help with diagnostics and other administrative tasks. These use the same configuration infrastructure as the daemons.
@ -37,7 +36,7 @@ Execute a token transfer on behalf of a custodial account.
@subsection tag (cic-eth-tag) @subsection tag (cic-eth-tag)
Associate an account address with a string identifier. @xref{cic-eth system accounts} Associate an account address with a string identifier. @xref{cic-eth-system-accounts}
@anchor{cic-eth-tools-ctrl} @anchor{cic-eth-tools-ctrl}

1
apps/cic-eth/doc/texinfo/transfertypes.texi
View File

@ -1,4 +1,3 @@
@node cic-eth-appendix-transaction-types
@appendix Transfer types @appendix Transfer types
@table @var @table @var