Skip to content

Commit bc347e3

Browse files
committed
Pull out info on the docs.perl6.org build
1 parent 5ef6dfd commit bc347e3

File tree

2 files changed

+17
-21
lines changed

2 files changed

+17
-21
lines changed

BUILD.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# htmlify.p overview
2+
3+
For syntax highlighting, needs node.js installed.
4+
Please run `make init-highlights` to automatically pull in the highlighting
5+
grammar and build the highlighter.
6+
7+
For doc.perl6.org, the build process goes like this:
8+
a cron job on hack.p6c.org as user 'doc.perl6.org' triggers the rebuild.
9+
10+
*/5 * * * * flock -n ~/update.lock -c ./doc/util/update-and-sync > update.log 2>&1
11+
12+
`util/update-and-sync` is under version control in the perl6/doc repo (same as
13+
this file), and it first updates the git repository. If something changed, it
14+
runs `htmlify.p6`, captures the output, and on success, syncs both the generated
15+
files and the logs. In case of failure, only the logs are synchronized.
16+
17+
The build logs are available at https://docs.perl6.org/build-log/

htmlify.p6

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,6 @@
11
#!/usr/bin/env perl6
22
use v6.c;
33

4-
=begin overview
5-
6-
This script isn't in bin/ because it's not meant to be installed.
7-
For syntax highlighting, needs node.js installed.
8-
Please run C<make init-highlights> to automatically pull in the highlighting
9-
grammar and build the highlighter.
10-
11-
For doc.perl6.org, the build process goes like this:
12-
a cron job on hack.p6c.org as user 'doc.perl6.org' triggers the rebuild.
13-
14-
*/5 * * * * flock -n ~/update.lock -c ./doc/util/update-and-sync > update.log 2>&1
15-
16-
C<util/update-and-sync> is under version control in the perl6/doc repo (same as
17-
this file), and it first updates the git repository. If something changed, it
18-
runs C<htmlify.p6>, captures the output, and on success, syncs both the generated
19-
files and the logs. In case of failure, only the logs are synchronized.
20-
21-
The build logs are available at https://docs.perl6.org/build-log/
22-
23-
=end overview
24-
254
BEGIN say 'Initializing ...';
265

276
use lib 'lib';

0 commit comments

Comments
 (0)