Skip to content

Commit

Permalink
manual: Remove "Caveats" section
Browse files Browse the repository at this point in the history
  • Loading branch information
tarsius committed Jul 17, 2024
1 parent eab630d commit d5ee56d
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 41 deletions.
17 changes: 0 additions & 17 deletions docs/forge.org
Original file line number Diff line number Diff line change
Expand Up @@ -243,23 +243,6 @@ the key for [email protected]:magit/forge.git~ is ~github.com~.
more repositories from a forge. Changing GITHOST and/or APIHOST
may be possible, but should seldom be necessary.

** Caveats

- Fetched information is stored in a database. The table schemata of
that database have not been finalized yet. Until that has happened
it will occasionally have to be discarded. That isn't such a huge
deal because for now the database does not contain any information
that cannot simply be fetched again, see [[*Initial Pull]].

- Fetching is implemented under the assumption that the API can be
asked to list the things that have changed since we last checked.
Unfortunately the APIs are not bug-free, so this is not always the
case. If in doubt, then re-fetch an individual topic to ensure it
is up-to-date using the command ~forge-pull-topic~.

- Some other, forge-specific, caveats are mentioned in [[*Supported
Forges and Hosts]].

* Getting Started

Much like Git stores information in a local repository and does not
Expand Down
24 changes: 0 additions & 24 deletions docs/forge.texi
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ Initial Setup
* Token Creation::
* Initial Pull::
* Repository Detection::
* Caveats::
Getting Started
Expand Down Expand Up @@ -137,7 +136,6 @@ a user.
* Token Creation::
* Initial Pull::
* Repository Detection::
* Caveats::
@end menu

@node Loading Forge
Expand Down Expand Up @@ -374,28 +372,6 @@ may be possible, but should seldom be necessary.
@end itemize
@end defopt

@node Caveats
@section Caveats

@itemize
@item
Fetched information is stored in a database. The table schemata of
that database have not been finalized yet. Until that has happened
it will occasionally have to be discarded. That isn't such a huge
deal because for now the database does not contain any information
that cannot simply be fetched again, see @ref{Initial Pull}.

@item
Fetching is implemented under the assumption that the API can be
asked to list the things that have changed since we last checked.
Unfortunately the APIs are not bug-free, so this is not always the
case. If in doubt, then re-fetch an individual topic to ensure it
is up-to-date using the command @code{forge-pull-topic}.

@item
Some other, forge-specific, caveats are mentioned in @ref{Supported Forges and Hosts}.
@end itemize

@node Getting Started
@chapter Getting Started

Expand Down

0 comments on commit d5ee56d

Please sign in to comment.