V3: review request for configure details page

* V3: review request for configure details page
@ 2014-02-27  3:53 Reyna, David
  2014-02-27 12:05 ` Barros Pena, Belen
  0 siblings, 1 reply; 6+ messages in thread
From: Reyna, David @ 2014-02-27  3:53 UTC (permalink / raw)
  To: Barros Pena, Belen, Damian, Alexandru; +Cc: Paul Eggleton, toaster

Hi Belen,

I have implemented the proposed design changes to the "Configure" page. 

   dreyna/configure-detail-view

I did need to make some small changes to the proposed design, as documented below. There are also some outstanding issues, which I also list below.

IMPLEMENTATION:

> 1) "Showing history for all variables"

Done.

> 2) "Searching and filtering" (Hidden file problem)

Done. 

I did however realize that "search" applies to all fields, not just the file list. This is an issue when you for example search the rpwsa for "BBINCLUDED", because suddenly all of the files would disappear because none would match. I do not think that this is what the user would expect when they are searching for variables and not file names.

Here is therefore how I implemented the file filtering:

  'search' 'file filter' Action
  -------- ------------- ----------------------
    -        -           show last file
  value      -           show last file, plus any file names that match search
    -      value         show only file names that match filter
  value    value         show any file names that match either string

I think that this meets out needs, and is a "least surprise" for users.

> 3) "Dealing with long values"

Done. To see it work, turn off the "Description" filter and look at the variable "BBINCLUDED", which is guaranteed to be bigger than 570 characters.

> 4) "What if a variable value is an empty string?"

Done.

> 5) "What do we do with the 613 B_* variables?"

They are now gone from the view.

> 6) "Linking variables to the Yocto Project reference manual"

Done. 

However, the statement "we do know that all variables with a description in documentation.conf have an entry in
the Yocto Project reference manual" is not universally true. Here are some counter examples:

  ALLOW_EMPTY_${PN}-dbg
  ASSUME_PROVIDED
  ASSUME_SHLIBS
  BBFILE_PATTERN_core
  BBFILE_PRIORITY_core
  ...

Some of these are obviously extended patterns, but the code does not know that, and there is no obvious way to filter for that.

LIMITATIONS:

7) There are still the observed defects. I will investigate, but they are outside of the code under review.

  * When you cancel the search string, the column filters are also reset.
  * The search will only test the first file in any vhistory list.
  * When using the search, each row will appear multiple times.

8) I have added the new Javascript code to support the value extender dialog to the file "templates/base.html", and it works! 

I do not know if this the best place. Nor do I know if it will affect other pages that would not otherwise use it.

I do observe that there is currently no way for a page to add local script code to the "<head>" section, which is currently locked inside "base.html". Maybe you can add script code to other sections, but I know that in testing that this new script section would not work when placed anywhere within "templates/configvars.html".

Thanks,
David

^ permalink raw reply	[flat|nested] 6+ messages in thread