Verified Commit f500376a authored by 35V LG84's avatar 35V LG84

Record tep-1009: txn-header and fix links

Record TEP-1009: Txn Header Syntax, and fix
bunch of links here and there.

[skip-ci]
Signed-off-by: 35V LG84's avatar35V LG84 <35vlg84-x4e6b92@e257.fi>
parent cfb62da6
Pipeline #52421837 skipped
......@@ -62,5 +62,5 @@ IntelliJ ANTLR plugin has really nice graphical tree display to visualize and te
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../LICENSE[License].
See the link:../../LICENSE[License] for the specific language governing permissions and limitations under
the link:../../LICENSE[License].
......@@ -17,10 +17,10 @@ For example Txn (single Transaction) or Txns (sequence of Transactions).
In case of tree-structures, child (singular) and childs (plural) is misspelled by purpose.
Tackler data model classes and objects are defined in
xref:../../core/src/main/scala/fi/e257/tackler/model[core / model] package.
link:../../core/src/main/scala/fi/e257/tackler/model/[core / model] package.
Tackler data model classes which are used between server and client are located in
xref:../../api/src/main/scala/fi/e257/tackler/api/[tackler-api] package. These API models
link:../../api/src/main/scala/fi/e257/tackler/api/[tackler-api] package. These API models
are serialized over wire by Circe as JSON, and there are deserializers available
as JavaScript and JVM for these models.
......@@ -34,7 +34,7 @@ All dates use subset of link:https://en.wikipedia.org/wiki/ISO_8601[ISO 8601] fo
* ISO DateTime with timezone offset or ZoneId
Internally all dates and time is handled as datetime with zone. If txn date does not have zone info,
then xref:../tackler.conf[configured] default zone is used.
then link:https://tackler.e257.fi/docs/tackler-conf/[configured] default zone is used.
If timezone is offset (`+02:00`) then it is *not* adjusted by daylight saving times.
When on the other hand, timezone as ZoneId (`e.g. Europe/Helsinki`) is adjusted by daylight saving time.
......@@ -88,8 +88,8 @@ own leaf-names, etc.
In default mode of operation, Tackler checks that all transactions postings
(e.g. accounts) are listed on Chart of Accounts. It is fatal error if there is
an account which is not listed. This can be lifted by xref:../accounts.conf[configuration and command
line parameter].
an account which is not listed. This can be lifted by
link:https://tackler.e257.fi/docs/accounts-conf/[configuration and command line parameter].
=== Accumulator and Reporting
......@@ -107,13 +107,13 @@ For parsing Tackler uses http://www.antlr.org/[ANTLR4].
Parser definition is located
* xref:../../core/src/main/antlr4/TxnLexer.g4[]
* xref:../../core/src/main/antlr4/TxnParser.g4[]
* link:../../core/src/main/antlr4/TxnLexer.g4[]
* link:../../core/src/main/antlr4/TxnParser.g4[]
Input is fed to the Parser by xref:../../core/src/main/scala/fi/e257/tackler/parser/TacklerTxns.scala[core / parser / TacklerTxns].
Input is fed to the Parser by link:../../core/src/main/scala/fi/e257/tackler/parser/TacklerTxns.scala[core / parser / TacklerTxns].
Result of parsing (e.g. ANTLR Parser Context) is converted to
the xref:../../core/src/main/scala/fi/e257/tackler/model[Tackler Model]
by xref:../../core/src/main/scala/fi/e257/tackler/parser/CtxHandler.scala[core / parser / CtxHandler]
the link:../../core/src/main/scala/fi/e257/tackler/model/[Tackler Model]
by link:../../core/src/main/scala/fi/e257/tackler/parser/CtxHandler.scala[core / parser / CtxHandler]
helper class.
== Input
......@@ -133,5 +133,5 @@ order is needed, then transactions must have UUIDs.
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../LICENSE[License].
See the xref:../../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../../LICENSE[License].
......@@ -66,5 +66,5 @@
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../LICENSE[License].
See the link:../../LICENSE[License] for the specific language governing permissions and limitations under
the link:../../LICENSE[License].
......@@ -22,5 +22,5 @@ Documentation for external systems, see:
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../LICENSE[License].
See the link:../../LICENSE[License] for the specific language governing permissions and limitations under
the link:../../LICENSE[License].
= Index of documentation
see link:https://tackler.e257.fi[Tackler's web site] for all user information and documentation.
see link:https://tackler.e257.fi/[Tackler's web site] for all user information and documentation.
== Developer documentation
......
......@@ -15,6 +15,7 @@ TEP Template: xref:./tep-0001.adoc[TEP-0001]
* xref:./tep-1005.adoc[TEP-1005: Txn filters]
* xref:./tep-1006.adoc[TEP-1006: CFG settings for report output scale]
* xref:./tep-1007.adoc[TEP-1007: Txn set checksum]
* xref:./tep-1008.adoc[TEP-1008: Numeric account names]
=== TEPs in implementation phase
......@@ -23,7 +24,7 @@ None at the moment
=== TEPs in planning phase
* xref:./tep-1008.adoc[TEP-1008: Numeric account names]
* xref:./tep-1009.adoc[TEP-1009: Txn header syntax]
* xref:./tep-1003.adoc[TEP-1003: Profit and Loss (PnL)]
......
= TEP-XXXX: name
See link:https://gitlab.com/e257/accounting/tackler/tree/tep/tep-XXXX-SHORT-NAME[/tep/tep-XXXX-SHORT-NAME]
branch for actual TEP-XXXX content.
Single line description of enhancement
Longer paragraph with high level explanation of enhancement
......@@ -56,8 +59,8 @@ Changes to client API or JSON model
* [ ] link / url of new dependency
** [ ] Add and check licenses: link / url
** [ ] Is there NOTICE file(s)?
** [ ] Add license under xref:../licenses[doc/licenses]
*** [ ] Add NOTICES under xref:../licenses[doc/licenses]
** [ ] Add license under link:../licenses/[doc/licenses]
*** [ ] Add NOTICES under link:../licenses/[doc/licenses]
** [ ] Add link of license to xref:../readme.adoc[index]
** [ ] Add link to xref:../../THANKS.adoc[THANKS]
** [ ] Add license material to binary distribution
......@@ -111,7 +114,7 @@ Changes to identity export
* [ ] xref:./readme.adoc[]: Update TEP index
* [ ] xref:../../README.adoc[]: is it a new noteworthy feature?
* [ ] xref:../../CHANGELOG[]: add new item
* [ ] link:../../CHANGELOG[]: add new item
* [ ] Does it warrant own T3DB file?
** [ ] update xref:../../tests/tests.adoc[]
** [ ] update xref:../../tests/check-tests.sh[]
......@@ -161,6 +164,8 @@ Is there need to run or create new perf tests?
=== Feature and Test case tracking
Feature-id:: <UUID>
xref:../../tests/tests-XXXX.yml[TEP-XXXX T3DB]
......@@ -199,5 +204,5 @@ features:
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../../LICENSE[License].
See the link:../../LICENSE[License] for the specific language governing permissions and limitations under
the link:../../LICENSE[License].
= TEP-1008: Numeric Account names
= TEP-1008: Numeric Account Names
Allow account names to start with numbers and/or be numeric only.
......
= TEP-1009: Transaction Header Syntax
See link:https://gitlab.com/e257/accounting/tackler/tree/tep/tep-1009-txn-header[/tep/tep-1009-txn-header]
branch for actual TEP-1009 content.
......@@ -2,8 +2,8 @@
This directory contains tools and reference results for Tackler's performance testing.
Performance test data is generated by by xref:../tools/generator[generator] tool.
Tools to run perf tests are located in xref:./bin[bin].
Performance test data is generated by by link:../tools/generator[generator] tool.
Tools to run perf tests are located in link:./bin[bin].
See link:https://tackler.e257.fi/docs/performance/[Description of Performance] for explanation
of generated artificial test data.
......@@ -22,7 +22,7 @@ your IDE might go nuts while it scans new files.
== Test data
Test data is generated with xref:../tools/generator[generator], version: 0.3.0
Test data is generated with link:../tools/generator[generator], version: 0.3.0
File count of test sets:
......
......@@ -5,23 +5,34 @@ cpu: Intel(R) Xeon(R) CPU E3-1265L V2 @ 2.50GHz
hd: Intel® SSD 530 Series
mem: 32GB
----
Raw test results: xref:./hw00/[HW00 (server)]
Raw test results: link:./hw00/[HW00 (server)]
If you are seeing this on GitLab, then inline graphs probably won't show up:
link:https://gitlab.com/gitlab-org/gitlab-ce/issues/17276[GitLab: Issue 17276]
== perf-1E3
link:./perf-hw00-1E3.svg[Graph: HW00 1E3]
image::perf-hw00-1E3.svg[]
== perf-1E4
link:./perf-hw00-1E4.svg[Graph: HW00 1E4]
image::perf-hw00-1E4.svg[]
== perf-1E5
link:./perf-hw00-1E5.svg[Graph: HW00 1E5]
image::perf-hw00-1E5.svg[]
== perf-1E6
link:./perf-hw00-1E6.svg[Graph: HW00 1E6]
image::perf-hw00-1E6.svg[]
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../../LICENSE[License].
See the link:../../LICENSE[License] for the specific language governing permissions and limitations under
the link:../../LICENSE[License].
......@@ -5,23 +5,38 @@ cpu: Intel(R) Core(TM) i5-2540M CPU @ 2.60GHz
hd: Intel(R) SSD 535
mem: 16GB
----
Raw test results: xref:./hw01/[HW01 (laptop)]
Raw test results: link:./hw01/[HW01 (laptop)]
If you are seeing this on GitLab, then inline graphs probably won't show up:
link:https://gitlab.com/gitlab-org/gitlab-ce/issues/17276[GitLab: Issue 17276]
== perf-1E3
link:./perf-hw01-1E3.svg[Graph: HW01 1E3]
image::perf-hw01-1E3.svg[]
== perf-1E4
link:./perf-hw01-1E4.svg[Graph: HW01 1E4]
image::perf-hw01-1E4.svg[]
== perf-1E5
link:./perf-hw01-1E5.svg[Graph: HW01 1E5]
image::perf-hw01-1E5.svg[]
== perf-1E6
link:./perf-hw01-1E6.svg[Graph: HW01 1E6]
image::perf-hw01-1E6.svg[]
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../../LICENSE[License].
See the link:../../LICENSE[License] for the specific language governing permissions and limitations under
the link:../../LICENSE[License].
......@@ -6,8 +6,8 @@ These are ballpark figures and should be treated as such. Test method contains
especially with smaller tests set (load time of JVM, JIT, etc.), however it should be good enough to validate
selected algorithms and overall memory usage with increasing work load.
Performance test data is generated by by xref:../tools/generator[generator] tool.
Tools to run perf tests are located in xref:./bin[bin].
Performance test data is generated by by link:../../tools/generator[generator] tool.
Tools to run perf tests are located in link:./../bin[bin].
== Test results
......@@ -31,7 +31,7 @@ Balance report, CPU utilization is around 540%
* 1E5 txns: 5 sec, 2.3GB
* 1E6 txns: 18 sec, 4.2GB, 56000 txn/s
Link to xref:./perf-hw00.adoc[detailed HW00 test results].
Link to link:./perf-hw00.adoc[detailed HW00 test results].
== HW01: Dual core system
......@@ -45,17 +45,17 @@ Balance report, CPU utilization is around 322%
* 1E5 txns: 8 sec, 2.3GB
* 1E6 txns: 32 sec, 4.3GB, 31000 txn/s
Link to xref:./perf-hw01.adoc[detailed HW01 test results].
Link to link:./perf-hw01.adoc[detailed HW01 test results].
=== Git storage performance testing
Git backend is currently based on single thread implementation.
* xref:./hw01/perf-git-1e3.txt[Git 1E3]
* xref:./hw01/perf-git-1e6.txt[Git 1E6]
* link:./hw01/perf-git-1e3.txt[Git 1E3]
* link:./hw01/perf-git-1e6.txt[Git 1E6]
'''
Tackler is distributed on an *"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND*, either express or implied.
See the xref:../../LICENSE[License] for the specific language governing permissions and limitations under
the xref:../../LICENSE[License].
See the link:../../LICENSE[License] for the specific language governing permissions and limitations under
the link:../../LICENSE[License].
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment