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

RFE: eliminate repeated file paths/URL in plain-text/HTML output #109

Open
kdudka opened this issue Feb 8, 2023 · 2 comments
Open

RFE: eliminate repeated file paths/URL in plain-text/HTML output #109

kdudka opened this issue Feb 8, 2023 · 2 comments

Comments

@kdudka
Copy link
Member

kdudka commented Feb 8, 2023

While working on issue #90, Cedric Buissart suggested to eliminate repeated URLs in the plain-text/HTML output of csdiff. When dealing with alerts reported by OWASP ZAP, the URLs can be too long, which makes csdiff's output difficult to read by people.

Ideally, we should implement it in a way that the plain-text or rendered HTML output is still readable by csdiff's coverity parser.

We should also be careful with changing the default output for tools like GCC because the plain-text output is often used by IDEs like vim's quickfix. So either we should use the simplification for http(s):// URLs only or make it configurable by an option.

@cedricbu
Copy link

IMHO : "make it configurable by an option" sounds like a better approach to me.
e.g. "--human-readable" which would enable something that's explicitly not-backward compatible (ie. future csdiff versions may make changes in the layout), made to be understood by human interpretation, not programs

@kdudka
Copy link
Member Author

kdudka commented Feb 14, 2023

@cedricbu Thanks for the input! The problem is that end-users often have no idea what csdiff is, yet they want to copy paste the human readable output to their own lists of findings and expect such lists to be machine readable again when using them later on. For example, commit 7a56fbb makes sure that HTML output rendered by a web browser is properly recognized as valid input data by csdiff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants