From a15292be644c5ee05d2e1da1f795cc9dda288072 Mon Sep 17 00:00:00 2001 From: Jarcode Date: Tue, 2 Apr 2019 17:18:41 -0700 Subject: [PATCH] Add prefix guidelines --- CONTRIBUTING.md | 2 ++ glava.c | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9393b8..e310414 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,6 +35,8 @@ If you use GNU Emacs, the above style can be configured via the following elisp: If you author and maintain your own shader module for GLava, you are free to use your preferred code style. Otherwise, shaders follow the same style as GLava's C sources. +The only exception to this is a hard rule for builtin prefixes. Variables should _never_ start with an underscore, as `__` are reserved by the GLSL compiler, and `_` are reserved for GLava builtins and namespaces. + ## Pull Requests You are free to make pull requests for any change, even if you are not sure if the proposed changes are appropriate. @wacossusca34 and/or @coderobe will be able to suggest changes or commentary on the PR if there is a reason it is not acceptable. diff --git a/glava.c b/glava.c index a28f19b..f7ab563 100644 --- a/glava.c +++ b/glava.c @@ -182,7 +182,7 @@ static const char* help_str = " appropriate backend will be used for the underlying windowing\n" " system.\n" "-a, --audio=BACKEND specifies an audio input backend to use.\n" - "-p, --pipe=BIND[:TYPE] binds a value to be read from stdin. The input my be read using\n" + "-p, --pipe=[BIND[:TYPE]] binds value(s) to be read from stdin. The input my be read using\n" " `@name` or `@name:default` syntax within shader sources.\n" " A stream of inputs (each overriding the previous) must be\n" " assigned with the `name = value` syntax and separated by\n"