I2P_Developers/i2p.www
3
0
Fork 5
Code Issues 27 Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Updated spec tags, and added instructions to README,

Browse Source 
as retrieved from 'mtn log spectags'.
This commit is contained in:
zzz
2020-05-01 13:37:21 +00:00
parent d28e6393ed
commit b641e2bcb3
2 changed files with 90 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -100,3 +100,15 @@ in `etc/translation.vars` can be overridden by creating the file
``` ```
$ tx push -s $ tx push -s
``` ```
## Updating spec tags:
ctags is used to generate references to the specifications.
The tags file is i2p2www/spec/spectags.
When the specifications are changed, the file should be regenerated and checked in.
Command to generate the file:
```
$ cd i2p2www/spec && ctags -f spectags --langdef=rst --langmap=rst:.rst --regex-rst=/_type-\([a-zA-Z0-9]+\)/\\1/t,type/ --regex-rst=/_struct-\([a-zA-Z0-9]+\)/\\1/s,struct/ --regex-rst=/_msg-\([a-zA-Z]+\)/\\1/m,msg/ -R -n *.rst
```

148
i2p2www/spec/spectags
View File

@ -4,73 +4,81 @@
!_TAG_PROGRAM_NAME Exuberant Ctags // !_TAG_PROGRAM_NAME Exuberant Ctags //
!_TAG_PROGRAM_URL http://ctags.sourceforge.net /official site/ !_TAG_PROGRAM_URL http://ctags.sourceforge.net /official site/
!_TAG_PROGRAM_VERSION 5.9~svn20110310 // !_TAG_PROGRAM_VERSION 5.9~svn20110310 //
BandwidthLimits i2cp.rst 441;" m BandwidthLimits i2cp.rst 467;" m
Boolean common-structures.rst 110;" t BlindingInfo i2cp.rst 496;" m
BuildRequestRecord i2np.rst 175;" s BuildRequestRecord i2np.rst 214;" s
BuildResponseRecord i2np.rst 349;" s BuildResponseRecord i2np.rst 390;" s
Certificate common-structures.rst 340;" t Certificate common-structures.rst 310;" t
CreateLeaseSet i2cp.rst 469;" m CreateLeaseSet i2cp.rst 585;" m
CreateSession i2cp.rst 503;" m CreateLeaseSet i2cp.rst 622;" m
Data i2np.rst 1098;" m CreateSession i2cp.rst 679;" m
DatabaseLookup i2np.rst 653;" m Data i2np.rst 1337;" m
DatabaseSearchReply i2np.rst 808;" m DatabaseLookup i2np.rst 718;" m
DatabaseStore i2np.rst 552;" m DatabaseSearchReply i2np.rst 1045;" m
Date common-structures.rst 80;" t DatabaseStore i2np.rst 596;" m
DeliveryInstructions common-structures.rst 1070;" s Date common-structures.rst 32;" t
DeliveryStatus i2np.rst 882;" m DeliveryInstructions common-structures.rst 1699;" s
DestLookup i2cp.rst 535;" m DeliveryStatus i2np.rst 1119;" m
DestReply i2cp.rst 557;" m DestLookup i2cp.rst 711;" m
Destination common-structures.rst 680;" s DestReply i2cp.rst 733;" m
DestroySession i2cp.rst 580;" m Destination common-structures.rst 673;" s
Disconnect i2cp.rst 599;" m DestroySession i2cp.rst 756;" m
Garlic i2np.rst 925;" m Disconnect i2cp.rst 775;" m
GarlicClove i2np.rst 394;" s EncryptedLeaseSet common-structures.rst 1394;" s
GarlicCloveDeliveryInstructions i2np.rst 456;" s Garlic i2np.rst 1162;" m
GetBandwidthLimits i2cp.rst 619;" m GarlicClove i2np.rst 435;" s
GetDate i2cp.rst 642;" m GarlicCloveDeliveryInstructions i2np.rst 497;" s
Hash common-structures.rst 293;" t GetBandwidthLimits i2cp.rst 795;" m
HostLookup i2cp.rst 675;" m GetDate i2cp.rst 818;" m
HostReply i2cp.rst 715;" m Hash common-structures.rst 263;" t
I2CPMessageHeader i2cp.rst 299;" s HostLookup i2cp.rst 851;" m
I2NPMessageHeader i2np.rst 93;" s HostReply i2cp.rst 891;" m
Integer common-structures.rst 67;" t I2CPMessageHeader i2cp.rst 315;" s
KeysAndCert common-structures.rst 580;" s I2NPMessageHeader i2np.rst 116;" s
Lease common-structures.rst 713;" s Integer common-structures.rst 19;" t
LeaseSet common-structures.rst 761;" s KeysAndCert common-structures.rst 573;" s
Mapping common-structures.rst 502;" t Lease common-structures.rst 706;" s
MessageId i2cp.rst 319;" s Lease2 common-structures.rst 891;" s
MessagePayload i2cp.rst 740;" m LeaseSet common-structures.rst 754;" s
MessageStatus i2cp.rst 761;" m LeaseSet2 common-structures.rst 1076;" s
Payload i2cp.rst 338;" s LeaseSet2Header common-structures.rst 1000;" s
PrivateKey common-structures.rst 145;" t Mapping common-structures.rst 495;" t
PublicKey common-structures.rst 128;" t MessageId i2cp.rst 335;" s
ReceiveMessageBegin i2cp.rst 903;" m MessagePayload i2cp.rst 927;" m
ReceiveMessageEnd i2cp.rst 929;" m MessageStatus i2cp.rst 948;" m
ReconfigureSession i2cp.rst 954;" m MetaLease common-structures.rst 1211;" s
ReportAbuse i2cp.rst 984;" m MetaLeaseSet common-structures.rst 1276;" s
RequestLeaseSet i2cp.rst 1012;" m OfflineSignature common-structures.rst 944;" s
RequestVariableLeaseSet i2cp.rst 1040;" m Payload i2cp.rst 354;" s
RouterAddress common-structures.rst 897;" s PrivateKey common-structures.rst 94;" t
RouterIdentity common-structures.rst 651;" s PublicKey common-structures.rst 62;" t
RouterInfo common-structures.rst 969;" s ReceiveMessageBegin i2cp.rst 1090;" m
SendMessage i2cp.rst 1066;" m ReceiveMessageEnd i2cp.rst 1116;" m
SendMessageExpires i2cp.rst 1109;" m ReconfigureSession i2cp.rst 1141;" m
SessionConfig i2cp.rst 358;" s ReportAbuse i2cp.rst 1171;" m
SessionId i2cp.rst 385;" s RequestLeaseSet i2cp.rst 1199;" m
SessionKey common-structures.rst 162;" t RequestVariableLeaseSet i2cp.rst 1227;" m
SessionStatus i2cp.rst 1252;" m RouterAddress common-structures.rst 1519;" s
SessionTag common-structures.rst 308;" t RouterIdentity common-structures.rst 644;" s
SetDate i2cp.rst 1297;" m RouterInfo common-structures.rst 1591;" s
Signature common-structures.rst 254;" t SendMessage i2cp.rst 1253;" m
SigningPrivateKey common-structures.rst 216;" t SendMessageExpires i2cp.rst 1296;" m
SigningPublicKey common-structures.rst 177;" t SessionConfig i2cp.rst 374;" s
String common-structures.rst 94;" t SessionId i2cp.rst 409;" s
Tunnel tunnel-message.rst 33;" m SessionKey common-structures.rst 126;" t
TunnelBuild i2np.rst 1127;" m SessionStatus i2cp.rst 1439;" m
TunnelBuildReply i2np.rst 1162;" m SessionTag common-structures.rst 278;" t
TunnelData i2np.rst 1020;" m SetDate i2cp.rst 1484;" m
TunnelGateway i2np.rst 1063;" m Signature common-structures.rst 222;" t
TunnelId common-structures.rst 323;" t SigningPrivateKey common-structures.rst 182;" t
TunnelMessageDeliveryInstructions tunnel-message.rst 161;" s SigningPublicKey common-structures.rst 141;" t
VariableTunnelBuild i2np.rst 1180;" m String common-structures.rst 46;" t
VariableTunnelBuildReply i2np.rst 1213;" m Tunnel tunnel-message.rst 36;" m
TunnelBuild i2np.rst 1371;" m
TunnelBuildReply i2np.rst 1412;" m
TunnelData i2np.rst 1259;" m
TunnelGateway i2np.rst 1302;" m
TunnelId common-structures.rst 293;" t
TunnelMessageDeliveryInstructions tunnel-message.rst 164;" s
VariableTunnelBuild i2np.rst 1434;" m
VariableTunnelBuildReply i2np.rst 1469;" m