[Forensics-changes] [yara] 47/192: Clarify yr_rules_{load, save}* descriptions (#536)

[Hilko Bengen]

This is an automated email from the git hooks/post-receive script.

bengen pushed a commit to annotated tag v3.6.0
in repository yara.

commit cc6adebae593255e60822d80cbe43798485ee26a
Author: Hilko Bengen <hillu at users.noreply.github.com>
Date:   Thu Oct 13 22:43:29 2016 +0200

    Clarify yr_rules_{load,save}* descriptions (#536)
    
    The documentation should make it clearer that these functions are for
    dealing with compiled rulesets, see https://github.com/hillu/go-yara/issues/6
---
 docs/capi.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/capi.rst b/docs/capi.rst
index 3bed484..913ece9 100644
--- a/docs/capi.rst
+++ b/docs/capi.rst
@@ -446,7 +446,7 @@ Functions
 
 .. c:function:: int yr_rules_save(YR_RULES* rules, const char* filename)
 
-  Save *rules* into the file specified by *filename*. Returns one of the
+  Save compiled *rules* into the file specified by *filename*. Returns one of the
   following error codes:
 
     :c:macro:`ERROR_SUCCESS`
@@ -457,13 +457,13 @@ Functions
 
   .. versionadded:: 3.4.0
 
-  Save *rules* into *stream*. Returns one of the following error codes:
+  Save compiled *rules* into *stream*. Returns one of the following error codes:
 
     :c:macro:`ERROR_SUCCESS`
 
 .. c:function:: int yr_rules_load(const char* filename, YR_RULES** rules)
 
-  Load rules from the file specified by *filename*. Returns one of the
+  Load compiled rules from the file specified by *filename*. Returns one of the
   following error codes:
 
     :c:macro:`ERROR_SUCCESS`
@@ -482,7 +482,7 @@ Functions
 
   .. versionadded:: 3.4.0
 
-  Load rules from *stream*. Returns one of the following error codes:
+  Load compiled rules from *stream*. Returns one of the following error codes:
 
     :c:macro:`ERROR_SUCCESS`
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/forensics/yara.git