|
1 Demoing the link checker. |
|
2 ========================= |
|
3 |
|
4 Before the demo |
|
5 --------------- |
|
6 |
|
7 The linkcheck executable is at: |
|
8 C:\apps\ditaot\DITA-OT1.5.1\python\dist\linkcheck.exe |
|
9 |
|
10 Fire up a shell and add to the path |
|
11 C:\> set PATH=C:\apps\ditaot\DITA-OT1.5.1\python\dist;%PATH% |
|
12 |
|
13 Navigate to a build, here I have assumed that a subst has been done, e.g. |
|
14 |
|
15 C:\>subst S: E:\hydra\201006All |
|
16 |
|
17 Move there: |
|
18 C:\>S: |
|
19 |
|
20 S:\> |
|
21 |
|
22 During the demo |
|
23 --------------- |
|
24 Show the knind of things that linkcheck does |
|
25 S:\>linkcheck -? |
|
26 This lists the errors that we check for and the options that it can take. |
|
27 |
|
28 [ |
|
29 Optionally can show off running lincheck unit tests but this will probably hang on the servers as they have no internet access: |
|
30 S:\>linkcheck -u -l30 |
|
31 ] |
|
32 |
|
33 |
|
34 Try it on raw Doxygen output: |
|
35 S:\>cd S:\epoc32\build\esockserver\c_2a28510674fa652b\ |
|
36 |
|
37 S:\epoc32\build\esockserver\c_2a28510674fa652b>linkcheck esocksvr_dll\dox\dita |
|
38 Should get something like: |
|
39 |
|
40 CMD: linkcheck esocksvr_dll\dox\dita |
|
41 2010-03-16 11:46:19,561 INFO DitaFileSet starting to read... |
|
42 2010-03-16 11:46:24,108 INFO DitaFileSet.finalise() start... |
|
43 2010-03-16 11:46:27,372 INFO DitaFileSet.finalise() done. |
|
44 ================================ Statistics =============================== |
|
45 Maps: 1 [ 0.000 M] |
|
46 Non-maps: 1670 [ 0.002 M] |
|
47 Files: 1671 [ 0.002 M] |
|
48 Bytes: 31033697 [ 29.596 M] |
|
49 IDs: 19636 [ 0.019 M] |
|
50 Refs: 37142 [ 0.035 M] |
|
51 Read time: 4.543 (s) |
|
52 Analysis time: 3.253 (s) |
|
53 =========================================================================== |
|
54 ============================== Error Summary ============================== |
|
55 Code Count Error |
|
56 ---- ----- ----- |
|
57 410 260 Can not resolve reference to file "..." |
|
58 411 3195 Can resolve reference to file "..." but not to fragment "..." |
|
59 505 40 Duplicate id="..." in files: ... |
|
60 =========================================================================== |
|
61 |
|
62 Show off multiprocessing: |
|
63 S:\epoc32\build\esockserver\c_2a28510674fa652b>linkcheck -j0 esocksvr_dll\dox\dita |
|
64 Read time is much faster. |
|
65 |
|
66 Now process some MODE guide: |
|
67 S:\epoc32\build\esockserver\c_2a28510674fa652b>cd \epoc32\release\doxygen\ |
|
68 Run linkcheck: |
|
69 S:\epoc32\release\doxygen>linkcheck -j0 "GUID-27F4B43B-13E2-425C-95B2-87A840AF614B (guide)" |
|
70 |
|
71 Show deeper analysis of error code 600: |
|
72 S:\epoc32\release\doxygen>linkcheck -j0 -e 600 --file=specific "GUID-27F4B43B-13E2-425C-95B2-87A840AF614B (guide)" |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 |
|
79 |