Skip to content

Commit 39067e9

Browse files
committed
Integrate test documentation and remove t/ directory
- Integrated information from t/README.md into docs/TESTING.md - Added section on 'Importing Perl5 Test Suite' with setup instructions - Removed t/ directory and its tracked files (t/README.md, t/test.pl) - Updated .gitignore to remove obsolete t/ directory entries - Testing section in README.md already up-to-date The t/ directory was a placeholder for imported Perl5 tests. The import process and instructions are now documented in docs/TESTING.md.
1 parent 4d67e0b commit 39067e9

File tree

4 files changed

+34
-2162
lines changed

4 files changed

+34
-2162
lines changed

.gitignore

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,6 @@ src/test/_Deparsed_XSubs.pm
2525
# Ignore Perl test suite files
2626
perl5/
2727

28-
# Ignore the t/ directory (Perl test suite copied from perl5/t/)
29-
# These should be synced from perl5 repo, not committed here
30-
t/
31-
# But keep our own t/README.md documentation
32-
!t/README.md
33-
!t/test.pl
34-
3528
# Ignore perl5_t/ directory (module tests from perl5/lib/*.t)
3629
# These are synced from perl5 repo via sync.pl, not committed here
3730
perl5_t/

docs/TESTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,40 @@ Check for infinite loops, use timeout command:
284284
timeout 30s ./jperl problematic_test.t
285285
```
286286

287+
## Importing Perl5 Test Suite
288+
289+
PerlOnJava can import and run tests from the official Perl5 repository to verify compatibility and behavior.
290+
291+
### Setup
292+
293+
To import Perl test files and verify their behavior under PerlOnJava:
294+
295+
1. Clone the Perl5 repository (if not already done):
296+
```bash
297+
rm -rf perl5 # if it exists
298+
git clone https://github.com/Perl/perl5.git
299+
```
300+
301+
2. Run the import script to copy tests and apply patches:
302+
```bash
303+
perl dev/import-perl5/sync.pl
304+
```
305+
306+
This will copy all files from `perl5/t/` to `t/` and apply any necessary patches for PerlOnJava compatibility.
307+
308+
### Running Imported Tests
309+
310+
To run the imported Perl5 tests:
311+
312+
```bash
313+
perl dev/tools/perl_test_runner.pl --output out.json t
314+
```
315+
316+
See `dev/import-perl5/README.md` for more details on:
317+
- The import system architecture
318+
- How to add patches for PerlOnJava compatibility
319+
- Managing test expectations
320+
287321
## See Also
288322

289323
- [Build Guide](BUILD.md) - Building PerlOnJava

t/README.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)