From 10a48556554d45a06b655ba2bae7717422d22f73 Mon Sep 17 00:00:00 2001
From: John Hodge <tpg@prelude.mutabah.net>
Date: Thu, 15 Apr 2010 10:43:37 +0800
Subject: [PATCH] Makefile cleanup, documentation

---
 Kernel/Makefile.BuildNum                 |  2 +-
 Kernel/include/adt.h                     | 24 +++++++++++++++++++-----
 Usermode/Libraries/acess.ld_src/Makefile |  4 +++-
 Usermode/Libraries/crt0.o_src/Makefile   |  4 ++--
 4 files changed, 25 insertions(+), 9 deletions(-)

diff --git a/Kernel/Makefile.BuildNum b/Kernel/Makefile.BuildNum
index 9a0157e1..bb3445a4 100644
--- a/Kernel/Makefile.BuildNum
+++ b/Kernel/Makefile.BuildNum
@@ -1 +1 @@
-BUILD_NUM = 1866
+BUILD_NUM = 1868
diff --git a/Kernel/include/adt.h b/Kernel/include/adt.h
index 724877c6..17f23876 100644
--- a/Kernel/include/adt.h
+++ b/Kernel/include/adt.h
@@ -6,15 +6,15 @@
 #define _ADT_H_
 
 /**
- * \name Ring Buffer
+ * \name Ring Buffers
  * \{
  */
 typedef struct sRingBuffer
 {
-	size_t	Start;
-	size_t	Length;
-	size_t	Space;
-	char	Data[];
+	size_t	Start;	//!< Start of data in ring buffer
+	size_t	Length;	//!< Number of data bytes in buffer
+	size_t	Space;	//!< Allocated space in buffer
+	char	Data[];	//!< Buffer
 }	tRingBuffer;
 
 /**
@@ -23,7 +23,21 @@ typedef struct sRingBuffer
  * \return Pointer to the buffer structure
  */
 extern tRingBuffer	*RingBuffer_Create(size_t Space);
+/**
+ * \brief Read at most \a Length bytes from the buffer
+ * \param Dest	Destinaton buffer
+ * \param Buffer	Source ring buffer
+ * \param Length	Requested number of bytes
+ * \return Number of bytes read
+ */
 extern size_t	RingBuffer_Read(void *Dest, tRingBuffer *Buffer, size_t Length);
+/**
+ * \brief Write at most \a Length bytes to the buffer
+ * \param Buffer	Destination ring buffer
+ * \param Source	Source buffer
+ * \param Length	Provided number of bytes
+ * \return Number of bytes written
+ */
 extern size_t	RingBuffer_Write(tRingBuffer *Buffer, void *Source, size_t Length);
 /**
  * \}
diff --git a/Usermode/Libraries/acess.ld_src/Makefile b/Usermode/Libraries/acess.ld_src/Makefile
index 82a7dd24..405ec203 100644
--- a/Usermode/Libraries/acess.ld_src/Makefile
+++ b/Usermode/Libraries/acess.ld_src/Makefile
@@ -3,12 +3,14 @@
 
 BIN = ../acess.ld
 
+.PHONY: all clean install
+
 all: ../acess.ld
 
 clean:
 	$(RM) ../acess.ld
 
-install:
+install: ../acess.ld
 
 ../acess.ld:	acess.ld.h
 	cpp -nostdinc -U i386 -P -C $< -o $@ -DACESSDIR=$(ACESSDIR)
diff --git a/Usermode/Libraries/crt0.o_src/Makefile b/Usermode/Libraries/crt0.o_src/Makefile
index f191556b..d15f271f 100644
--- a/Usermode/Libraries/crt0.o_src/Makefile
+++ b/Usermode/Libraries/crt0.o_src/Makefile
@@ -6,11 +6,11 @@
 
 ASFLAGS = -felf
 
-.PHONY: all clean
+.PHONY: all clean install
 
 all: ../crt0.o
 
-install:
+install: ../crt0.o
 
 clean:
 	$(RM) ../crt0.o
-- 
2.20.1