Skip to content

Commit 281ee98

Browse files
authored
Deprecate old qaxml tools (#228)
1 parent a26c5c9 commit 281ee98

File tree

6 files changed

+21
-55
lines changed

6 files changed

+21
-55
lines changed

scripts/translation/README.md

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -142,56 +142,3 @@ php doc-base/scripts/translation/qaxml-tags.php --content=filename
142142
php doc-base/scripts/translation/qaxml-tags.php --content=literal
143143
php doc-base/scripts/translation/qaxml-tags.php --content=varname
144144
```
145-
146-
---
147-
148-
## Old tools (below)
149-
150-
Document below is the previous version of these tools. These tools are
151-
deprecated, and scheduled for remotion very soon.
152-
153-
154-
These old tools needed to be separated configured, before use:
155-
```
156-
php doc-base/scripts/translation/configure.php $LANG_DIR
157-
```
158-
159-
## qarvt.php
160-
161-
`qarvt.a.php` checks if all translated files have revtags in the
162-
expected format.
163-
164-
## qaxml.a.php
165-
166-
`qaxml.a.php` checks if all updated translated files have
167-
the same tag-attribute-value triplets. Tag's attributes are extensively
168-
utilized in manual for linking and XIncluding. Translated files with
169-
missing or mistyped attributes may cause build failing or missing
170-
parts, not copied by XIncludes.
171-
172-
## qaxml.e.php
173-
174-
`qaxml.e.php` checks if all updated translated files have
175-
the same external entities as the original files. Unbalanced entities
176-
may indicate mistyped or wrongly translated parts.
177-
178-
## qaxml.p.php
179-
180-
`qaxml.p.php` checks if all updated translated files have
181-
the same processing instructions as the original files. Unbalanced PIs
182-
may cause compilation errors, as they are utilized in the manual build
183-
process.
184-
185-
## qaxml.t.php
186-
187-
`qaxml.t.php` checks if all updated translated files have
188-
the same tags as the original files. Different number of tags between
189-
source texts and target translations may cause compilation errors.
190-
191-
Usage: `php qaxml.t.php [--detail] [tag[,tag]]`
192-
193-
`[tag[,tag]]` is a comma separated tag list to check their
194-
contents, as some tag contents are expected *not* be translated.
195-
196-
`--detail` will also print line definitions of each mismatched tag,
197-
to facilitate bitsecting.

scripts/translation/qaxml.a.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
* +----------------------------------------------------------------------+
1818
*/
1919

20+
echo "This tool is obsolete and will be REMOVED soon.\n";
21+
echo "See https://github.com/php/doc-base/blob/master/scripts/translation/README.md\n";
22+
echo "for alternatives.\n\n".
23+
2024
require_once __DIR__ . '/lib/all.php';
2125

2226
$qalist = QaFileInfo::cacheLoad();

scripts/translation/qaxml.e.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
* +----------------------------------------------------------------------+
1818
*/
1919

20+
echo "This tool is obsolete and will be REMOVED soon.\n";
21+
echo "See https://github.com/php/doc-base/blob/master/scripts/translation/README.md\n";
22+
echo "for alternatives.\n\n".
23+
2024
require_once __DIR__ . '/lib/all.php';
2125

2226
$qalist = QaFileInfo::cacheLoad();

scripts/translation/qaxml.p.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
* +----------------------------------------------------------------------+
1818
*/
1919

20+
echo "This tool is obsolete and will be REMOVED soon.\n";
21+
echo "See https://github.com/php/doc-base/blob/master/scripts/translation/README.md\n";
22+
echo "for alternatives.\n\n".
23+
2024
require_once __DIR__ . '/lib/all.php';
2125

2226
$qalist = QaFileInfo::cacheLoad();

scripts/translation/qaxml.t.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
* +----------------------------------------------------------------------+
1818
*/
1919

20+
echo "This tool is obsolete and will be REMOVED soon.\n";
21+
echo "See https://github.com/php/doc-base/blob/master/scripts/translation/README.md\n";
22+
echo "for alternatives.\n\n".
23+
2024
require_once __DIR__ . '/lib/all.php';
2125

2226
$tags = [];

scripts/translation/qaxml.w.php

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
* +----------------------------------------------------------------------+
1818
*/
1919

20+
echo "This tool is obsolete and will be REMOVED soon.\n";
21+
echo "See https://github.com/php/doc-base/blob/master/scripts/translation/README.md\n";
22+
echo "for alternatives.\n\n".
23+
2024
require_once __DIR__ . '/lib/all.php';
2125

2226
$qalist = QaFileInfo::cacheLoad();
@@ -41,7 +45,7 @@ function whitespaceCheckFile( string $filename )
4145

4246
$xml = XmlUtil::loadFile( $filename );
4347
$tags = XmlUtil::listNodeType( $xml , XML_ELEMENT_NODE );
44-
48+
4549
foreach( $tags as $node )
4650
{
4751
switch ( $node->nodeName )
@@ -64,4 +68,3 @@ function whitespaceCheckFile( string $filename )
6468

6569
$output->print();
6670
}
67-

0 commit comments

Comments
 (0)