[jira] [Created] (YARN-8801) java doc comments in docker-util.h is confusing

["Zian Chen (JIRA)" <ji...@apache.org>]

Zian Chen created YARN-8801:
-------------------------------

             Summary: java doc comments in docker-util.h is confusing
                 Key: YARN-8801
                 URL: https://issues.apache.org/jira/browse/YARN-8801
             Project: Hadoop YARN
          Issue Type: Sub-task
            Reporter: Zian Chen
            Assignee: Zian Chen


{code:java}
 /**
+ * Get the Docker exec command line string. The function will verify that the params file is meant for the exec command.
+ * @param command_file File containing the params for the Docker start command
+ * @param conf Configuration struct containing the container-executor.cfg details
+ * @param out Buffer to fill with the exec command
+ * @param outlen Size of the output buffer
+ * @return Return code with 0 indicating success and non-zero codes indicating error
+ */
+int get_docker_exec_command(const char* command_file, const struct configuration* conf, args *args);{code}
The method param list have out an outlen which didn't match the signature, and we miss description for param args. 



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: yarn-issues-help@hadoop.apache.org