From: Mark Wooding <mdw@distorted.org.uk>
Date: Wed, 17 Jul 2024 11:22:02 +0000 (+0100)
Subject: checkpath.c: Describe the `struct checkpath' as `query', not `context'.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/checkpath/commitdiff_plain/459742fa2b2aff1dd5de1e19b3df6213c5742ddc?ds=inline

checkpath.c: Describe the `struct checkpath' as `query', not `context'.

We're going to be introducing a `state', and it will be confusing to
have both a state and a context.
---

diff --git a/checkpath.c b/checkpath.c
index 440a6ab..8d03113 100644
--- a/checkpath.c
+++ b/checkpath.c
@@ -173,7 +173,7 @@ static void push(struct elt *e)
 
 /* --- @report@ --- *
  *
- * Arguments:	@const struct checkpath *cp@ = pointer to context
+ * Arguments:	@const struct checkpath *cp@ = pointer to query
  *		@unsigned what@ = what sort of report is this?
  *		@int verbose@ = how verbose is this?
  *		@const char *p@ = what path does it refer to?
@@ -269,7 +269,7 @@ static void report(const struct checkpath *cp, unsigned what, int verbose,
  *
  * Arguments:	@const char *p@ = name of directory to check
  *		@struct stat *st@ = pointer to @stat@(2) block for it
- *		@const struct checkpath *cp@ = pointer to caller parameters
+ *		@const struct checkpath *cp@ = pointer to query
  *		@unsigned f@ = various flags (@SF_...@)
  *
  * Returns:	Zero if everything's OK, else bitmask of problems.