pfSense » pfSense Docs

I have been modifying the pfSense-pkg-pimd package, in order to support the upcoming pimd-version-3 release (still in beta, not yet publicly available). So same status for an upcomming pfSense-pkg-pimd-v3.

During that process I was facing a couple of documentation issues.

Please take care of the following documentation points:

a) https://docs.netgate.com/pfsense/en/latest/development/developing-packages.html#repository-branches
does not work: git clone git@github.com:pfsense/FreeBSD-ports.git pfSense-ports
should be: git clone https://github.com/pfsense/FreeBSD-ports.git pfSense-ports

b) NetGate is using git/github that is perfectly ok, however could you describe how that relates to the traditional FreeBSD ports, in relation pfSense of cause:
- /var/git/pfSense-ports/<cat>/<package> <> /usr/ports/<cat>/<package>
- gnu-auto-tools <> port commands
- git distribution-file => ports/distfiles > package <> git => make package => package

c) https://docs.netgate.com/pfsense/en/latest/development/developing-packages.html#repository-branches
Manifest File: description is probably not up to date
- a shell script is generated and placed in the "packet" directory
- I assume that that is the start/restart/stop script
- the scriptgenerator is called by write_rcfile(array("file" => "pimd.sh", "start" => $rc_file_start, "stop" => $rc_file_stop)
- I cannot find the script generator code related to “write_rcfile” in the git repository

d) “write_rcfile” is called from “<git/port>/<cat>/<packagename>/files/usr/local/pkg/<packagename>.inc”
- “<packagename>.inc” is generating the parameter values as needed by “write_rcfile”, however ... to do that you need package knowledge.
- so I am very surprises that “<packagename>.inc” has a big warning inside “This file was created by an automatic configuration generator.” Where 1) I can not locate that generator in the git directory and
2) …… independent of that magical generator, it does need input to do its work ….. and I could not find any file inside the package having that info …. Apart from the file “<packagename>.inc” itself !!??

e) Please indicate the directorys used / to use. I Assume:
- the packet gui-directory seems to be “/use/local/pkg/<packetname>/”
- the socket directory seems to be “/var/run/”
- start/stop/restart/script “/usr/local/etc/rc.d/”
- packet config /var/etc/<packetname>/

Sincerely,

Louis