# what are .rst files? **URL:** \ **Category:** Development\ **Tags:** development\ **Created:** [July 19, 2011, 9:51pm UTC](https://community.zeek.org/t/what-are-rst-files/1930 "2011-07-19T21:51:50Z")\ **Posts on this page:** 6\ **Page:** 1
**Author:** ![Vern](https://yyz1.discourse-cdn.com/flex011/user_avatar/community.zeek.org/vern/32/630_2.png) [@Vern](https://community.zeek.org/u/Vern)\ **Post date:** [July 19, 2011, 9:51pm UTC](https://community.zeek.org/t/what-are-rst-files/1930/1 "2011-07-19T21:51:50Z")
While debugging Bro, during one of the runs it created: -rw-r--r-- 1 vern admin 0 Jul 19 11:39 \^\.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 bro.bif.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 bro.init.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 const.bif.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 event.bif.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^logging^\_\_load\_\_.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^logging^base.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^logging^plugins^ascii.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^notice^\_\_load\_\_.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^notice^base.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^notice^weird.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^packet-filter^\_\_load\_\_.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^packet-filter^base.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 frameworks^packet-filter^netstats.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 logging.bif.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 reporter.bif.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 site.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 strings.bif.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 types.bif.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 utils^conn\_ids.rst -rw-r--r-- 1 vern admin 0 Jul 19 11:39 utils^pattern.rst (Note the charmingly named "\^\.rst"!) What's up with this?     Vern ---
**Author:** ![Adam\_J\_Slagell](https://avatars.discourse-cdn.com/v4/letter/a/c2a13f/32.png) [@Adam\_J\_Slagell](https://community.zeek.org/u/Adam_J_Slagell)\ **Post date:** [July 19, 2011, 9:53pm UTC](https://community.zeek.org/t/what-are-rst-files/1930/2 "2011-07-19T21:53:46Z")
Output from the Documentation framework? ---
**Author:** ![Vern](https://yyz1.discourse-cdn.com/flex011/user_avatar/community.zeek.org/vern/32/630_2.png) [@Vern](https://community.zeek.org/u/Vern)\ **Post date:** [July 19, 2011, 9:55pm UTC](https://community.zeek.org/t/what-are-rst-files/1930/3 "2011-07-19T21:55:48Z")
> Output from the Documentation framework? Well, if you want to call zero-length files "documentation" :-). Yeah, I must have tripped across one of Bro's flags to do that. That said, (1) why are these files empty, and (2) why does one of them have the name \^\.rst ?     Vern ---
**Author:** ![Jonathan\_Siwek](https://avatars.discourse-cdn.com/v4/letter/j/e68b1a/32.png) [@Jonathan\_Siwek](https://community.zeek.org/u/Jonathan_Siwek)\ **Post date:** [July 19, 2011, 10:03pm UTC](https://community.zeek.org/t/what-are-rst-files/1930/4 "2011-07-19T22:03:37Z")
> \> Output from the Documentation framework? Yes. (the command line args to toggle it are -Z and --doc-scripts) > (1) why are these files empty, because bro crashed at a point point during parsing, but before writing them? > and (2) why does one of them have the name \^\.rst The \ part is a bug, it should be called just \.rst (meaning generated documentation for scripting given to bro on standard input) - Jon ---
**Author:** ![Vern](https://yyz1.discourse-cdn.com/flex011/user_avatar/community.zeek.org/vern/32/630_2.png) [@Vern](https://community.zeek.org/u/Vern)\ **Post date:** [July 19, 2011, 10:08pm UTC](https://community.zeek.org/t/what-are-rst-files/1930/5 "2011-07-19T22:08:07Z")
> because bro crashed at a point point during parsing, but before writing them? Ah - yeah, pretty much. I reproduced the behavior - running bro -Z and then issuing ^C to terminate it results in zero-length files. If instead I provide it with any valid input, then I get the generated files. > The \ part is a bug, it should be called just \.rst > (meaning generated documentation for scripting given to bro on standard input) Okay, I've filed a ticket on it.     Vern ---
**Author:** ![system](https://canada1.discourse-cdn.com/flex011/uploads/zeek/original/1X/f09d732bc2cc7c7cc7e35db67cf4e1d5233ce7a7.png) [@system](https://community.zeek.org/u/system)\ **Post date:** [May 6, 2022, 3:39pm UTC](https://community.zeek.org/t/what-are-rst-files/1930/6 "2022-05-06T15:39:40Z")