Always exit code 64?

[mzur]

I wanted to replace Sami with Doctum for my API documentation and it looked easy enough. But now I noticed that Doctum seems to always return with exit code 64. I also tested it with the Laravel API documentation (as defined here) and it also returns with exit code 64:

$ php doctum.phar update doctum.php; echo $?
 Updating project 

Version 5.5
------------


Version 5.8
------------


Version 6.x
------------


Version 7.x
------------


Version 8.x
------------


Version master
---------------


 Version    Updated C    Removed C 
      5.5            0            0
      5.8            0            0
      6.x            0            0
      7.x            0            0
      8.x            0            0
   master            0            0

 Version    Updated C    Updated N    Removed C    Removed N 
      5.5            0            0            0            0
      5.8            0            0            0            0
      6.x            0            0            0            0
      7.x            0            0            0            0
      8.x            0            0            0            0
   master            0            0            0            0

64

The documentation seems to be generated just fine in any case. It's just the exit code that bothers me (and my build pipeline).

[williamdes]

Hi @mzur
You can use --ignore-parse-errors to exit 0 if the build succeeds

(By the way their run.sh file is unsafe, it should have a set -e to exit when a command exists a non zero code.)

$ ./bin/doctum.php 
Doctum 5.4.0-dev by Fabien Potencier and William Desportes

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  help    Displays help for a command
  list    Lists commands
  parse   Parses a project
  render  Renders a project
  update  Parses then renders a project

$ ./bin/doctum.php parse --help
Description:
  Parses a project

Usage:
  parse [options] [--] <config>

Arguments:
  config                             The configuration file

Options:
      --only-version=ONLY-VERSION    The version to build
      --force                        Forces to rebuild from scratch
      --output-format=OUTPUT-FORMAT  The format to display errors [default: "rawtext"]
      --no-progress                  Do not display the progress bar
      --ignore-parse-errors          Ignores parse errors and exits 0
  -h, --help                         Display help for the given command. When no command is given display help for the list command
  -q, --quiet                        Do not output any message
  -V, --version                      Display this application version
      --ansi                         Force ANSI output
      --no-ansi                      Disable ANSI output
  -n, --no-interaction               Do not ask any interactive question
  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  The parse command parses a project and generates a database
  with API information:
  
      php ./bin/doctum.php parse config/symfony.php
  
  The --force option forces a rebuild (it disables the
  incremental parsing algorithm):
  
      php ./bin/doctum.php parse config/symfony.php --force
  
  The --version option overrides the version specified
  in the configuration:
  
      php ./bin/doctum.php parse config/symfony.php --version=main

[mzur]

Thanks, this makes sense! I'd suggest to display a warning message such as "There were X parsing errors. Use '-v' to display the errors." in cases like these. Otherwise it's totally unclear why the command did not succeed, as the errors are only displayed while parsing and are hidden again in the final output.

[williamdes]

Yeah, I totally agree this is something that should be changed in next major and improved in next release