[PATCH] D42963: Add initial ld.lld.1 man page

[Rafael Avila de Espindola via llvm-commits]

Ed Maste via Phabricator <reviews at reviews.llvm.org> writes:

> emaste created this revision.
> emaste added reviewers: ruiu, rafael.
> Herald added a subscriber: krytarowski.
>
> One of our requirements in FreeBSD to enable lld as the system linker was that it has a man page. We created the man page in this review, and offer it for inclusion upstream.
>
> Some options are missing detail, but it should make a good starting point.
>
>
> https://reviews.llvm.org/D42963
>
> Files:
>   docs/ld.lld.1
>
> Index: docs/ld.lld.1
> ===================================================================
> --- /dev/null
> +++ docs/ld.lld.1
> @@ -0,0 +1,364 @@
> +.\"-
> +.\" Copyright (c) 2018 Kirill Ponomarev
> +.\" Copyright (c) 2018 The FreeBSD Foundation
> +.\"
> +.\" Redistribution and use in source and binary forms, with or without
> +.\" modification, are permitted provided that the following conditions
> +.\" are met:
> +.\" 1. Redistributions of source code must retain the above copyright
> +.\"    notice, this list of conditions and the following disclaimer.
> +.\" 2. Redistributions in binary form must reproduce the above copyright
> +.\"    notice, this list of conditions and the following disclaimer in the
> +.\"    documentation and/or other materials provided with the distribution.
> +.\"
> +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
> +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> +.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
> +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
> +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
> +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
> +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
> +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
> +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
> +.\" SUCH DAMAGE.
> +.\"
> +.\" $FreeBSD: head/usr.bin/clang/lld/ld.lld.1 328810 2018-02-02 21:52:00Z emaste $

Could this used the standard llvm license header?

> +.It Fl -color-diagnostics= Ns Ar value
> +Use colors in diagnostics.
> +.It Fl -color-diagnostics
> +Use colors in diagnostics.

Can we merge the two?

> +.It Fl -full-shutdown
> +Perform a full shutdown instead of calling
> +.Fn _exit .

Not sure if this one should be in the manpage.

> +.It Fl -no-as-needed
> +Always set

Can we merge the -no-foo options with the -foo options?

Cheers,
Rafael