Stream: brlcad

Topic: documentation


view this post on Zulip Sean (Aug 05 2020 at 06:11):

This took far longer than I care to admit, but here's a new amalgamation visual overview of BRL-CAD. Feedback appreciated: https://brlcad.org/BRL-CAD_Overview.pdf

view this post on Zulip Sumagna Das (Aug 05 2020 at 06:34):

looking good but couldnt see much of the pdf. its taking time on my computer. will see the whole of it later

view this post on Zulip Sean (Feb 15 2022 at 20:31):

FYI, I updated https://brlcad.org/wiki/Compiling and merged it with the other wiki compilation pages. Tried to keep it as terse but informative as possible, avoiding being wordy or explanatory. Review and feedback appreciated.

I also updated https://brlcad.org/docs/api and our Jenkins integration so that's back up and automatically publishing again when the build is clean.

view this post on Zulip Sean (Feb 15 2022 at 20:31):

Will be working on publishing the new docs effort next, so we can avoid diverging and take advantage of the new structure dashamir worked on last fall. Hopefully have that done in time for GSoC!

view this post on Zulip starseeker (Feb 15 2022 at 20:37):

Do we still need lex and yacc?

view this post on Zulip Sean (Feb 15 2022 at 22:22):

What's the context? Need lex and yacc for docs?? I don't think so. We have a couple files that I've kept around because they're good reference, but nothing in active use any more that I'm aware of.

view this post on Zulip starseeker (Feb 15 2022 at 22:24):

I noticed it as being called out in the Debian packages for installation (byacc and flex)

view this post on Zulip Sean (Feb 15 2022 at 22:24):

o.O

view this post on Zulip starseeker (Feb 15 2022 at 22:24):

aptitude install sed byacc flex xsltproc libncursesw5-dev

view this post on Zulip Sean (Feb 15 2022 at 22:24):

sure enough.. I didn't see that

view this post on Zulip Sean (Feb 15 2022 at 22:29):

All the Linux suggestions could be out of date -- I don't use them, didn't write them. Can you check ubuntu/debian for relevance? I just removed a few but don't know if things like libncurses are still used if found.

view this post on Zulip starseeker (Feb 15 2022 at 22:29):

Sure.

view this post on Zulip Sean (Feb 15 2022 at 22:32):

I just updated the section in case you need to refresh

view this post on Zulip starseeker (Feb 15 2022 at 22:33):

Yeah, I think the ncurses package can go now.

view this post on Zulip Sean (Feb 15 2022 at 22:33):

It wasn't needed before, but it was better to link against it than have it use termcap or termio or some other fallback.

view this post on Zulip starseeker (Feb 15 2022 at 22:34):

<nod> Our usage of those APIs generally is way down now - I think it's mostly a couple of the fb tools, and their usage is very simple.

view this post on Zulip Sean (Feb 15 2022 at 22:34):

I don't see a terminal interface in the dependency listing, so if not ncurses, it'll need something listed still

view this post on Zulip Sean (Feb 15 2022 at 22:35):

if memory serves, ncurses pulls in termcap

view this post on Zulip starseeker (Feb 15 2022 at 22:35):

I think libtermio is fairly self contained... I'll have to check what its external requirements are. They should be minimal.

view this post on Zulip starseeker (Feb 15 2022 at 22:37):

Do we still use libxi-dev? I can never remember if the Xi bits are still there or not.

view this post on Zulip Sean (Feb 15 2022 at 22:38):

I think it's "technically" optional, but it's really needed to get input devices to behave properly. I'd keep it.

view this post on Zulip starseeker (Feb 15 2022 at 22:39):

I'll have to pay closer attention the next time I set up a vanilla VM - I know for the Qt stuff, particularly if you want to build qt6 yourself, there's a bunch of stuff you need.

view this post on Zulip starseeker (Feb 15 2022 at 22:40):

I think for the remaining terminal bits its looking as long as you have one of termios.h, termio.h (SYSV) or sys/ioctl.h (BSD) you're OK...

view this post on Zulip Sean (Feb 15 2022 at 22:40):

Yeah, mged uses it optionally. It's what makes shift-grips works smoothly across input devices, and I think enables other input devices.

view this post on Zulip starseeker (Feb 15 2022 at 22:41):

libtermio doesn't link any external libs - just libbu.

view this post on Zulip Sean (Feb 15 2022 at 22:47):

sure, it's just a low-level terminal I/O -- it uses, however, some lower-level platform-specific method for talking to a terminal
(hence termio.h termios.h, sys/ioctl_compat.h, etc.)

view this post on Zulip Sean (Feb 15 2022 at 22:48):

If I have my dependencies correct, ncurses was its (libtermio's) modern system replacement. we bundled a bare minimum.

view this post on Zulip starseeker (Feb 15 2022 at 22:49):

libc6-dev gives us termio.h on Ubuntu

view this post on Zulip Sean (Feb 15 2022 at 22:51):

Is aptitude even installed by default? Or should we list the instructions for apt-get or dnf or whatever else is default instead?

view this post on Zulip starseeker (Feb 15 2022 at 22:52):

I usually use apt, but I'm kinda old-school... not sure what the cool kids use these days.

view this post on Zulip Sean (Feb 15 2022 at 22:53):

I've seen a report from someone saying they didn't have aptitude in their ubuntu, but they followed the instructions using something else, so apt would be better if it's the base and simple enough

view this post on Zulip Sean (Feb 15 2022 at 22:53):

my understanding is aptitude is really for the GUI

view this post on Zulip starseeker (Feb 15 2022 at 22:57):

That's looking fairly close now for Debian/Ubuntu - we've still got libxext-dev called out in the README (?)

view this post on Zulip starseeker (Feb 15 2022 at 22:57):

Oh, of course - opengl

view this post on Zulip starseeker (Feb 15 2022 at 22:57):

libglu1-mesa-dev

view this post on Zulip starseeker (Feb 15 2022 at 23:07):

The BSD comment made me chuckle

view this post on Zulip Sean (Jun 07 2022 at 21:54):

Now that's a long-overdue fix... just finished doing a barebones cleanup of the html command page that displays in mged/archer. Was an incoherent mess. Can be improved and should become auto-generated (any takers?), but now has a proper auto-adjusting menu and all the commands are at least mostly using the same styling now: image.png


Last updated: Oct 09 2024 at 00:44 UTC