diff options
| author | Hans Ulrich Niedermann <hun@n-dimensional.de> | 2021-10-31 11:22:04 +0100 |
|---|---|---|
| committer | Hans Ulrich Niedermann <hun@n-dimensional.de> | 2021-10-31 11:23:18 +0100 |
| commit | 8cee604f738b14bb5d2e90b01d20ceb130b0c4b5 (patch) | |
| tree | 0dd458c4dcbfbe9abafe27e4173f9bffe3ae0c97 /HACKING.md | |
| parent | c164ad79f8c493aeab8c37ada1808806f1f69f1d (diff) | |
| download | libgphoto2-8cee604f738b14bb5d2e90b01d20ceb130b0c4b5.tar.gz | |
HACKING.md: Misc small improvements (grammar, whitespace, etc.)
Diffstat (limited to 'HACKING.md')
| -rw-r--r-- | HACKING.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/HACKING.md b/HACKING.md index bef15b310..9bcaa324f 100644 --- a/HACKING.md +++ b/HACKING.md @@ -101,11 +101,11 @@ before you commit any changes, double check with the author that your changes won't break the driver. If you want to write a driver for gphoto2, the easiest way to do so -would be to copy over the contents of camlibs/template and fill in +would be to copy over the contents of `camlibs/template/` and fill in your code. Use something like `CHECK_RESULT` (see for example -`libgphoto2/filesys.c`). +`libgphoto2/gphoto2-filesys.c`). Let's say you write a driver called sillycam. Please set up a file called `library.c` containing all gphoto2-specific code (like @@ -154,7 +154,7 @@ my_func (int arg) /* * This is a multiline - * comment. Use TAB for + * comment. Use TAB for * indentation! */ res = gp_some_action (var); @@ -178,9 +178,9 @@ my_func (int arg) } ``` -Please always check the return value of `gp_`-functions! We defined some -handy macros all over the place (like `CHECK_RESULT`) - by using those, -you'll avoid lots of `if () {} else {}`. +Please always check the return value of `gp_`-functions! We have +defined some handy macros all over the place (like `CHECK_RESULT`) - +by using those, you'll avoid lots of `if () {} else {}`. Emacs users may define and use a `gphoto-c-mode` by putting the following stuff into their `.emacs` file: @@ -195,7 +195,7 @@ following stuff into their `.emacs` file: (c-set-style "linux") (setq indent-tabs-mode t) (font-lock-mode)) - + ;; (setq auto-mode-alist (cons '("/home/user/src/gphoto.*\\.[ch]$" . gphoto-c-mode) auto-mode-alist)) @@ -320,7 +320,7 @@ for more details. at once. The macros have the form `AANN[a]toh` or `htoAANN[a]`, where `AA` is - `le` (little-endian) or `be` (big-endian), `NN` is `16` or `32` + `le` (little-endian) or `be` (big-endian), `NN` is `16`, `32`, or `64` (bits in the word) and `a`, if present, means that the preceding type is located in a byte array, not an integer. `h` refers to `host`, and could be big or little-endian depending on the current |