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.

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

backport 6.x: doc: update file.data keyword documentation v1 6563 #9862

Conversation

jmtaylor90
Copy link
Contributor

Make sure these boxes are signed before submitting your Pull Request -- thank you.

Link to redmine ticket:

https://redmine.openinfosecfoundation.org/issues/6563

Describe changes:

  • backport of file.data keyword doc updates

Provide values to any of the below to override the defaults.

To use a pull request use a branch name like pr/N where N is the
pull request number.

Alternatively, SV_BRANCH may also be a link to an
OISF/suricata-verify pull-request.

SV_REPO=
SV_BRANCH=
SU_REPO=
SU_BRANCH=
LIBHTP_REPO=
LIBHTP_BRANCH=

@jmtaylor90 jmtaylor90 requested review from norg and a team as code owners November 21, 2023 22:06
@jmtaylor90 jmtaylor90 changed the title backport 6x: doc: update file.data keyword documentation v1 6563 backport 6.x: doc: update file.data keyword documentation v1 6563 Nov 21, 2023
Copy link
Contributor

@jufajardini jufajardini left a comment

Choose a reason for hiding this comment

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

While reviewing our merging PR, I noticed a difference between the documentation for file.data in 6 and the ones for 7 and 8. Left an inline comment about it :)

@@ -787,3 +787,4 @@ Notes
pattern '<html' is absent from the first inspected chunk.

- ``file_data`` can also be used with SMTP
Copy link
Contributor

Choose a reason for hiding this comment

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

A bit confused wrt why this was left here, but removed from 7 and 8 documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It looks like I missed this part when I was fixing up the cherry-pick conflicts (I also apparently forgot the -x). I can get this fixed up.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, thanks! I'll leave the decision to Victor in this, but IMHO a fixup works.

Copy link
Member

@inashivb inashivb left a comment

Choose a reason for hiding this comment

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

Missing the cherry-picked from line in commit message needed to correlate backports. See 2440413

It can be done with git cherry-pick -x <commit-hash> while cherry picking a commit.

@victorjulien
Copy link
Member

Missing the cherry-picked from line in commit message needed to correlate backports. See 2440413

It can be done with git cherry-pick -x <commit-hash> while cherry picking a commit.

I don't think this is critical for doc backports, esp contributed ones. And especially since we're not documenting this anywhere. See also https://redmine.openinfosecfoundation.org/issues/6568

@jmtaylor90
Copy link
Contributor Author

continued in #9867

@jmtaylor90 jmtaylor90 closed this Nov 22, 2023
@jmtaylor90 jmtaylor90 deleted the 6563-backport-doc-file-data-keyword-v1 branch May 7, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants