Merge pull request #831 from CEED/jeremy/minor-typo

doc - minor typo

Author: jeremylt

Makefile

@@ -641,7 +641,7 @@ install : $(libceed) $(OBJDIR)/ceed.pc
 	$(INSTALL_DATA) include/ceed.h "$(DESTDIR)$(includedir)/"
 	$(INSTALL_DATA) include/ceedf.h "$(DESTDIR)$(includedir)/"
 
-.PHONY : all cln clean doxygen doc lib install par print test tst prove prv prove-all junit examples style style-c style-py tidy info info-backends info-backends-all
+.PHONY : all cln clean doxygen doc lib install par print test tst prove prv prove-all junit examples style style-c style-py tidy iwyu info info-backends info-backends-all
 
 cln clean :
 	$(RM) -r $(OBJDIR) $(LIBDIR) dist *egg* .pytest_cache *cffi*
@@ -687,6 +687,17 @@ tidy_cpp : $(libceed.cpp:%=%.tidy)
 
 tidy : tidy_c tidy_cpp
 
+ifneq ($(wildcard ../iwyu/*),)
+  IWYU_DIR ?= ../iwyu
+endif
+ifneq ($(IWYU_DIR),)
+  IWYU_CC = $(IWYU_DIR)/build/bin/include-what-you-use
+
+  iwyu_cc :
+    CC = $(IWYU_CC)
+  iwyu : lib | iwyu_cc
+endif
+
 print :
 	@echo $(VAR)=$($(VAR))
 

doc/sphinx/source/libCEEDdev.md

@@ -30,15 +30,17 @@ run on a single file, use
 
 for example.  All issues reported by `make tidy` should be fixed.
 
-## Header Files
+## Include-What-You-Use
 
 Header inclusion for source files should follow the principal of 'include what you use' rather than relying upon transitive `#include` to define all symbols.
 
-Every symbol that is used in the source file `foo.c` should be defined in `foo.c`, `foo.h`, or in a header file ``` #include``d in one of these two locations.
-Please check your code by running the tool ``include-what-you-use ``` to see recommendations for changes to your source.
+Every symbol that is used in the source file `foo.c` should be defined in `foo.c`, `foo.h`, or in a header file `#include`d in one of these two locations.
+Please check your code by running the tool [`include-what-you-use`](https://include-what-you-use.org/) to see recommendations for changes to your source.
 Most issues reported by `include-what-you-use` should be fixed; however this rule is flexible to account for differences in header file organization in external libraries.
+If you have `include-what-you-use` installed in a sibling directory to libCEED, then you can use the makefile target `make iwyu`.
 
 Header files should be listed in alphabetical order, with installed headers preceding local headers and `ceed` headers being listed first.
+The `ceed-f64.h` and `ceed-f32.h` headers should only be included in `ceed.h`.
 
 ```c
 #include <ceed.h>
@@ -67,7 +69,7 @@ for (d=0; d<dim; d++)
   for (c=0; c<num_comp; c++)
     for (q=0; q<Q; q++)
       for (e=0; e<num_elem; e++)
-        u[((d*num_comp + c)*Q + q)*nnum_elemlem + e] = ...
+        u[((d*num_comp + c)*Q + q)*num_elem + e] = ...
 ```
 
 This ordering is sometimes referred to as row-major or C-style.  Note

doc/sphinx/source/releasenotes.md

@@ -24,6 +24,7 @@ for each release of libCEED.
 ### Maintainability
 
 - Refactored preconditioner support internally to facilitate future development and improve GPU completeness/test coverage.
+- `Include-what-you-use` makefile target added as `make iwyu`.
 
 (v0-9)=