Question regarding directory structure and files

[vicennial]

Hello everyone,

I've been trying to understand the files involved for implementing a specific function in pgRouting. I've been exploring the source code a bit and came up with this table to understand the different directories and files:

Directory	File	Use
include	*.hpp	Contains functions,classes. Actual algorithm implemented here.
doc	*.rst	Documentation. Final docs generated from theses files
sql	myfunction.sql	Contains specific parameters of each function and input/return types. (One-one, Many-one,etc)
sql	_myfunction.sql	Generalised parameters of each function
src	myfunction_driver.cpp	Handle actual calling of functions implemented in .hpp files. Exception handling. Error msg generation.
src	myfunction.c	Handle connection between sql and C/ C++.
test	*.sql	Test queries
test	*.result	Expected result of the test queries
test	*.conf	Perl file for configuration
pgtap	*.sql	More tests

A couple of questions:

• Is the table information accurate?
• Any suggestions for libraries/tutorials/documentation to read to further understand/write code for files such as src/myfunction.c ?
• Difference between pgTap tests and files in "test/" directory? Why not only have pgTap tests?

[vicennial]

A few more questions after your explanation:

• Is C used only because C++/SQL connection library does not exist?
• Do we use #if 0 for code commenting because using normal comments affects doc generation?

[dkastl]

@vicennial , this table would actually make a nice Wiki page.

[vicennial]

@dkastl Thanks, will make a wiki page with the updated/detailed version.