[lld] missing doc entry for error handling script

Fix http://lab.llvm.org:8011/#/builders/69/builds/67
This commit is contained in:
serge-sans-paille 2020-11-03 11:14:38 +01:00
parent 54d8627852
commit 3bdeb2ac2e
1 changed files with 35 additions and 0 deletions

View File

@ -0,0 +1,35 @@
=====================
Error Handling Script
=====================
LLD provides the ability to hook into some error handling routines through a
user-provided script specified with ``--error-handling-script=<path to the script>``
when certain errors are encountered. This document specifies the requirements of
such a script.
Generic Requirements
====================
The script is expected to be available in the ``PATH`` or to be provided using a
full path. It must be executable. It is executed in the same environment as the
parent process.
Arguments
=========
LLD calls the error handling script using the following arguments::
error-handling-script <tag> <tag-specific-arguments...>
The following tags are supported:
- ``missing-lib``: indicates that LLD failed to find a library. The library name
is specified as the second argument, e.g. ``error-handling-script missing-lib
mylib``
Return Value
============
Upon success, the script is expected to return 0. A non-zero value is
interpreted as an error and reported to the user. In both cases, LLD still
reports the original error.