From: Ben Pfaff <blp@cs.stanford.edu>
Date: Wed, 4 Jan 2006 20:08:04 +0000 (+0000)
Subject: Add clarifying comment.
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?p=pintos-anon;a=commitdiff_plain;h=6b6152842350f855579701d2405910411c6a6e81

Add clarifying comment.
Via Bruce Schechter.
---

diff --git a/src/userprog/process.c b/src/userprog/process.c
index 6150a06..a81ca59 100644
--- a/src/userprog/process.c
+++ b/src/userprog/process.c
@@ -386,8 +386,12 @@ setup_stack (void **esp)
 }
 
 /* Adds a mapping from user virtual address UPAGE to kernel
-   virtual address KPAGE to the page table.  Fails if UPAGE is
-   already mapped or if memory allocation fails. */
+   virtual address KPAGE to the page table.
+   UPAGE must not already be mapped.
+   KPAGE should probably be a page obtained from the user pool
+   with palloc_get_page().
+   Returns true on success, false if UPAGE is already mapped or
+   if memory allocation fails. */
 static bool
 install_page (void *upage, void *kpage)
 {