comments for top level Rules and java rules/dummy

rellermeyer · Nov 22, 2016 · 293eabc · 293eabc
1 parent 7348eb1
commit 293eabc
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/Rules.mk b/Rules.mk
@@ -1,6 +1,9 @@
+# Compiles the source file using the specified compiler + flags
+# Note $< is the first specified dependency, in this case the source
 compile: $(SRC)
 	$(CC) $(CFLAGS) $<
 
+# Runs the code.
 run: compile
 	$(RUNCMD) $(RUNFLAGS) $(TEST_FILE)
 

diff --git a/java/Rules.mk b/java/Rules.mk
@@ -1,7 +1,10 @@
+# Specify how to compile + how to run
 CC:=javac
 CFLAGS:=
 OBJ:=$(SRC:.java=.class)
 RUNCMD:=java
 RUNFLAGS:=-cp . $(OBJ:.class=)
 
+# include the top level Rules.mk (note this is called from the context
+# of the Makefile in a directory below this one)
 include ../../Rules.mk
diff --git a/java/dummy/Makefile b/java/dummy/Makefile
@@ -1,3 +1,4 @@
+# Specify the source file
 SRC:=Dummy.java
 
 include ../Rules.mk