Re: [PATCH 1/2] doc: replace use of environment variables with a generated config

[Tomi Ollila]

On Tue, Jul 14 2020, Floris Bruynooghe wrote:

> On Sat 11 Jul 2020 at 10:20 -0300, David Bremner wrote:
>
>> I don't love the use of exec, but it is getting unwieldy to pass
>
> It's already a config file written in Python which is a terrible sin.
> So no need to apologise, I think it makes sense in this context.
>
>> configuration options on the sphinx-build command line, and I
>> anticipate further use of conditionals.
>> ---
>>  configure  |  8 
>>  doc/Makefile.local |  2 +-
>>  doc/conf.py| 11 ---
>>  3 files changed, 17 insertions(+), 4 deletions(-)
>>
>> diff --git a/configure b/configure
>> index 80cbac4f..177432db 100755
>> --- a/configure
>> +++ b/configure
>> @@ -1548,6 +1548,14 @@ NOTMUCH_HAVE_PYTHON3_PYTEST=${have_python3_pytest}
>>  PLATFORM=${platform}
>>  EOF
>>  
>> +cat > sphinx.config <> +# Generate by configure, run from doc/conf.py
>
> Minor insignificant typo: Generated

Just to tease David more, I think I had that fixed in my suggestion ;)
LFTM with this typo fixed.

Tomi

>
>> +EOF
>> +if [ $WITH_EMACS = "1" ]; then
>> +printf "tags.add('WITH_EMACS')\n" >> sphinx.config
>> +fi
>> +printf "rsti_dir = '%s'\n" $(realpath emacs) >> sphinx.config
>> +
>>  # Finally, after everything configured, inform the user how to continue.
>>  cat <>  
>> diff --git a/doc/Makefile.local b/doc/Makefile.local
>> index 769438ed..598b6028 100644
>> --- a/doc/Makefile.local
>> +++ b/doc/Makefile.local
>> @@ -4,7 +4,7 @@ dir := doc
>>  
>>  # You can set these variables from the command line.
>>  SPHINXOPTS:= -q
>> -SPHINXBUILD   = WITH_EMACS=${WITH_EMACS} RSTI_DIR=$(realpath emacs) 
>> sphinx-build
>> +SPHINXBUILD   = sphinx-build
>>  DOCBUILDDIR  := $(dir)/_build
>>  
>>  # Internal variables.
>> diff --git a/doc/conf.py b/doc/conf.py
>> index 70987ac5..fdff2a2c 100644
>> --- a/doc/conf.py
>> +++ b/doc/conf.py
>> @@ -22,6 +22,13 @@ for pathdir in ['.', '..']:
>>  with open(version_file,'r') as infile:
>>  version=infile.read().replace('\n','')
>>  
>> +# read generated config
>> +for pathdir in ['.', '..']:
>> +conf_file = os.path.join(location,pathdir,'sphinx.config')
>> +if os.path.exists(conf_file):
>> +with open(conf_file,'r') as infile:
>> +exec(''.join(infile.readlines()))
>> +
>>  # The full version, including alpha/beta/rc tags.
>>  release = version
>>  
>> @@ -29,12 +36,10 @@ release = version
>>  # directories to ignore when looking for source files.
>>  exclude_patterns = ['_build']
>>  
>> -if os.environ.get('WITH_EMACS') == '1':
>> +if tags.has('WITH_EMACS'):
>>  # Hacky reimplementation of include to workaround limitations of
>>  # sphinx-doc
>>  lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
>> -rsti_dir = os.environ.get('RSTI_DIR')
>> -# the other files are from the build tree
>>  for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 
>> 'notmuch-tag.rsti'):
>>  lines.extend(open(rsti_dir+'/'+file))
>>  rst_epilog = ''.join(lines)
> ___
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-le...@notmuchmail.org
___
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-le...@notmuchmail.org

notmuch_database_index_file with relative paths.

[David Bremner]

This is a sanity check on a bug I stumbled upon while writing unit tests
for error handling in the library.

The attached test script (meant to be run from within the test subdir of
a built source tree) demonstrates trying (and failing) to index a
relative path.

Am I missing something here, or does _notmuch_message_file_open_ctx (or
something that calls it) need to check for absolute paths and prepend
the mail root if not?

I'm just a bit surprised that no-one hit this before.

#!/usr/bin/env bash
test_description="notmuch_database_* API"

. $(dirname "$0")/test-lib.sh || exit 1

add_email_corpus

test_begin_subtest "building database"
test_expect_success "NOTMUCH_NEW"

cat < c_head
#include 
#include 
#include 
#include 
int main (int argc, char** argv)
{
   notmuch_database_t *db;
   notmuch_status_t stat;
   char *msg = NULL;

   stat = notmuch_database_open_verbose (argv[1], NOTMUCH_DATABASE_MODE_READ_WRITE, , );
   if (stat != NOTMUCH_STATUS_SUCCESS) {
 fprintf (stderr, "error opening database: %d %s\n", stat, msg ? msg : "");
 exit (1);
   }
EOF

cat <<'EOF' > c_tail
   if (stat) {
   const char *stat_str = notmuch_database_status_string (db);
   if (stat_str)
   fputs (stat_str, stderr);
}

}
EOF

generate_message '[filename]=relative_path'
test_subtest_known_broken
test_begin_subtest "index file (relative path)"
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
{
notmuch_message_t *msg;
stat = notmuch_database_index_file (db, "relative_path", NULL, );
printf ("%d\n", stat == NOTMUCH_STATUS_SUCCESS);
}
EOF
cat < EXPECTED
== stdout ==
1
== stderr ==
EOF
test_expect_equal_file EXPECTED OUTPUT

test_done
___
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-le...@notmuchmail.org