[PATCH] D116566: [flang] Fix the documentation on how to build flang

[Pete Steinfeld via Phabricator via llvm-commits]

PeteSteinfeld added inline comments.


================
Comment at: flang/README.md:101
+To do the standalone build, start the same way by cloning the source for
+llvm-project:
+```bash
----------------
rovka wrote:
> I have 2 mostly orthogonal comments here:
> 
> 1. People might skip directly to this section and then be surprised a few lines down when you mention the in tree build. I think this paragraph should make it clear from the start that you're expected to go through the previous section first. We should probably also mention that if you're building standalone you no longer need to include flang in LLVM_ENABLE_PROJECTS for the in tree build (otherwise people will end up building flang twice when they're really only interested in the standalone one).
> 
> 2. Do we really need to clone again? It should work to just point cmake to the flang subdirectory inside the first clone.
Thanks for the feedback, Diana.

Good point about needing to tell people that building in tree is a prerequisite for building standalone.  I'll add some text.

I originally did not include flang in the list of projects for the in tree build, but an earlier reviewer requested it.  In fact, my normal practice is to include it, if only to be able to run the flang tests and verify that the source code is good.  I'll add a note to capture this.

You don't need to clone again.  But that's my normal practice.  This is because I typically create one base, in tree build and then create several standalone builds that all use that base builds.  Typically, these stand-along builds have different Git repositories than the base build.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D116566