[PATCH] D132893: Add docs for Mach-O lld

[Jez Ng via Phabricator via llvm-commits]

int3 added inline comments.


================
Comment at: lld/docs/MachO/index.rst:1-2
+LLD - The LLVM Linker
+=====================
+
----------------
looks like this was written using lld/docs/index.rst as a template, but IMO we should make it more similar to lld/docs/WebAssembly.rst -- something that's a sub-page of index.rst

(Unfortunately index.rst itself talks at length about features specific to the ELF backend w/o making it clear that those features don't apply to other ports, and we should clean that up at some point...)


================
Comment at: lld/docs/MachO/index.rst:54-55
+
+Internals
+---------
+
----------------
I think we should rm everything in this Internals section -- no need to duplicate the top-level index.rst contents


================
Comment at: lld/docs/MachO/index.rst:55
+The user may also need to add ``-Wl,--deduplicate-literals`` in order
+to match Apple's linker behavior more closely.
+
----------------
michaeleisel wrote:
> oontvoo wrote:
> > smeenai wrote:
> > > michaeleisel wrote:
> > > > thakis wrote:
> > > > > Should this point at…uh,  lld/MachO/ld64-vs-lld.rst.
> > > > > 
> > > > > Also, we should move  lld/MachO/ld64-vs-lld.rst  out of the source tree into the doc tree, right, @oontvoo?
> > > > Sure, how about another sentence saying, "For more details on the differences between ld64 and LLD, see [here](...)"? Although, I don't know what the link is. Also, can I render this somehow locally to see how it looks and if the links work?
> > > Make sure you have `sphinx-build` in your path (I've found `pip` to be the easiest way to do this), and then set `LLVM_ENABLE_SPHINX` to `ON` in your CMakeCache.txt and reconfigure, then build the `docs-lld-html` target. It'll take a bit the first time, but incremental builds should be pretty quick. 
> > > Should this point at…uh,  lld/MachO/ld64-vs-lld.rst.
> > > 
> > > Also, we should move  lld/MachO/ld64-vs-lld.rst  out of the source tree into the doc tree, right, @oontvoo?
> > 
> > Yeah, I think the intention was that we'd keep this ld64-vs-lld.rst here in the source tree until the linker is "officially" released. 
> > So now is as good a time as any.
> > 
> > 
> > 
> OK, I've moved it
yep, the intention was to make it become one of the nicely-rendered doc pages. Thanks for moving!


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D132893/new/

https://reviews.llvm.org/D132893