From 15ba357fa1b309171b4a6def367b7f82724f2e55 Mon Sep 17 00:00:00 2001 From: David Timber Date: Mon, 6 Dec 2021 15:21:52 +0800 Subject: Documentation progress, bug fix, interface change * Update vscode settings for Doxygen * Fix mem leak in prne_index_bin_archive() * Fix bug where errno is not set in prne_htbt_parse_args() * Change names of parameter to prne_htbt_cp_hover() * Add template for Doxygen comment blocks --- doc/htbt.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/htbt.md') diff --git a/doc/htbt.md b/doc/htbt.md index 7bf5f64..4fc9fb5 100644 --- a/doc/htbt.md +++ b/doc/htbt.md @@ -302,7 +302,7 @@ representation from/to two's complement representation. | | | required is not implemented | | PROTO_ERR | 0x02 | Protocol error was detected while processing frames | | ERRNO | 0x03 | Operation was not successful and *err* is set to errno | -| SUB | 0x04 | *err* is set to the error code returned from the module | +| SUB | 0x04 | *err* is set to the error code returned from the module | | LIMIT | 0x05 | Request could not be served because a limit was reached | ### Hostinfo Frame @@ -747,7 +747,7 @@ The submissive host is allowed to choose an alternative architecture if the one requested is unavailable when the **C**("compat") flag is set. The submissive host is required to transmit the copy of its executable if **S**("self") is set. The binary recombination target is specified in **os** and **arch** fields. -These fields are ignored if *S* is set. +These fields are ignored if **S** is set. ## Enum Codes ### CPU Architecture Codes @@ -781,7 +781,7 @@ More on arch codes in [dev_notes](dev_notes.md). | Enum | Value | Description | | ------- | ----- | ---------------------------------------------------------- | | NONE | 0x00 | Special value used to indicate that the code is not used | -| LINUX | 0x01 | Linux ABI | +| LINUX | 0x01 | Linux ABI (Linux Standard Base) | The OS codes are used to represent the ABI the executable is compiled against. Proone is designed with portability in mind and OS codes will be used to -- cgit