X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fmodel%2Fcurrent%2Ftop.rst;h=e824225698c3d03b8c9200b549fadc467a4a1ffb;hb=bfbdfaedb044b7643b81f47e76285baedfee9e25;hp=d86e3fde4c9e44a53ed1ebc1a6a60431ef440950;hpb=01d8f262afc567c3d49a23c3cb2cdeaced8a6887;p=csit.git diff --git a/docs/model/current/top.rst b/docs/model/current/top.rst index d86e3fde4c..e824225698 100644 --- a/docs/model/current/top.rst +++ b/docs/model/current/top.rst @@ -1,5 +1,5 @@ .. - Copyright (c) 2021 Cisco and/or its affiliates. + Copyright (c) 2022 Cisco and/or its affiliates. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: @@ -22,7 +22,7 @@ especially the export side (UTI), not import side (PAL). Version ~~~~~~~ -This document is valid for CSIT model version 1.0.0. +This document is valid for CSIT model version 1.1.0. It is recommended to use semantic versioning: https://semver.org/ That means, if the new model misses a field present in the old model, @@ -54,15 +54,7 @@ If the suite name contains spaces (Robot converts underscores to spaces), they are replaced with underscores. The filesystem tree is rooted under tests/ (as suites in git are there), -and for each component (test case, suite setup, suite teardown) -two files are generated. -The "raw" variant is suitable for debugging (can contain lower level logging), -while the "info" variant is suitable for processing by PAL -(can contain derivative values so PAL does not need to compute them -on every download). -Their structure and content is mostly identical, model definition mentions -if a particular subschema is not identical in the two variants. -It is possible to convert from raw to info, but not the other way. +and for each component (test case, suite setup, suite teardown). Although we expect only ASCII text in the exported files, we manipulate files using UTF-8 encoding,