Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document container tasks in GMP doc #688

Merged
merged 6 commits into from
Aug 15, 2019
Merged

Document container tasks in GMP doc #688

merged 6 commits into from
Aug 15, 2019

Conversation

mattmundell
Copy link
Contributor

@mattmundell mattmundell commented Aug 13, 2019 •
edited
Loading

Checklist:

@mattmundell mattmundell marked this pull request as ready for review August 13, 2019 15:07
bjoernricks
bjoernricks reviewed Aug 14, 2019
View reviewed changes
Copy link
Contributor

@bjoernricks bjoernricks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just removed some additional spaces. Not sure if they have been added by intention.

src/schema_formats/XML/GMP.xml.in
@@ -5777,6 +5777,18 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
<p>
The client uses the create_task command to create a new task.
</p>
<p>
When given a target with an id of 0, the command creates a
"container" task. This kind of task can not be run, but it
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"container" task. This kind of task can not be run, but it
"container" task. This kind of task can not be run, but it

src/schema_formats/XML/GMP.xml.in
When given a target with an id of 0, the command creates a
"container" task. This kind of task can not be run, but it
is possible to import reports into the task. Importing is
done using the create_report command. The report being
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
done using the create_report command. The report being
done using the create_report command. The report being

src/schema_formats/XML/GMP.xml.in
@@ -20408,6 +20436,12 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
the values of the sort order, sort field and apply overrides flag
that the manager applied when selecting the tasks.
</p>
<p>
A task may be a "container" task. This means the task may not be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A task may be a "container" task. This means the task may not be
A task may be a "container" task. This means the task may not be

src/schema_formats/XML/GMP.xml.in
<p>
A task may be a "container" task. This means the task may not be
run, but reports may be uploaded to the task with the command
create_report. Container tasks are identified by having an empty
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
create_report. Container tasks are identified by having an empty
create_report. Container tasks are identified by having an empty

src/schema_formats/XML/GMP.xml.in
@@ -20899,6 +20933,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
<name>id</name>
<type>uuid</type>
<required>1</required>
<summary>ID of target. Empty for container tasks</summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<summary>ID of target. Empty for container tasks</summary>
<summary>ID of target. Empty for container tasks</summary>

@mattmundell
Copy link
Contributor Author

Just removed some additional spaces. Not sure if they have been added by intention.

These are to make the text easier to read in fixed width fonts, like on a terminal.
It's intentional (actually automatic for me, it's a very old habit).

I'm reluctant to change it in this patch because it's all over the document already.
Even the licence boilerplate has it (because it's the GNU standard).

@bjoernricks
Copy link
Contributor

Feel free to leave the PR as it is :-)

@timopollmeier timopollmeier merged commit 47157eb into greenbone:master Aug 15, 2019
@mattmundell mattmundell deleted the container-doc branch August 16, 2019 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjoernricks bjoernricks bjoernricks left review comments

@timopollmeier timopollmeier timopollmeier approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mattmundell @bjoernricks @timopollmeier