[FFmpeg-devel] [PATCH v4 1/4] avutil/{avstring, bprint}: add XML escaping from ffprobe to avutil

Nicolas George george at nsup.org
Mon Feb 1 14:25:02 EET 2021


Jan Ekström (12021-02-01):
> I fear that those sound way, way too generic. "This escapes all XML"
> definitely is not what that does.
> 
> And yes, even if it has the better definition in the Doxygen comment.

Why? Do you expect to add something that "escapes all XML"? What does it
even mean?

These symbols are what developers will need to type. Making them long is
just a waste of time. Adding hard to remembers parts like "ATT" (is it
"ATTR"? or "ATTRIBUTE"?) is just adding insult to injury.

Make the documentation as clear as possible, but keep the symbols short
and easy to remember.

Regards,

-- 
  Nicolas George
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20210201/f0b7cb21/attachment.sig>


More information about the ffmpeg-devel mailing list