Sheriffing/How To/Helpers

Command Line

mach file-info bugzilla-component lookup shortcut (mfi)

If the bugzilla product and component for a file or folder have to be looked up on Linux, provide the file name, folder name, the path or only a part of any of this to retrieve this information with

mfi search_term

while in the root folder of the mozilla-unified repository.

• In your home directory, check if there is a file called .bash_aliases.
• If not, create it, e.g. with the file manager: menu 'File' > 'New Document'.
• Add the following code:

mfi() {
    ./mach file-info bugzilla-component `find -path "*$1*" -not -path "./.hg/*" -not -path "./testing/web-platform/meta/*"`
}

• Save and close the file.
• New console windows will be support the mfi command to find matching files and check for their bugzilla products and components. If it doesn't find matches, error messages are shown.

Examples:

File name

$ mfi browser_treeupdate_canvas.js
Core :: Disability Access APIs
  accessible/tests/browser/e10s/browser_treeupdate_canvas.js

Part of file name

$ mfi treeupdate_canvas.js
Core :: Disability Access APIs
  accessible/tests/browser/e10s/browser_treeupdate_canvas.js

$ mfi wasm/webapi/invalid-code
Core :: Javascript: Web Assembly
  testing/web-platform/tests/wasm/webapi/invalid-code.any.js

Folder name

$ mfi accessible/tests/browser/
Core :: Disability Access APIs
  accessible/tests/browser/.eslintrc.js
  accessible/tests/browser/bounds
  ...
  accessible/tests/browser/tree/browser_aria_owns.js
  accessible/tests/browser/tree/head.js

Active tree in command line prompt

Let the command line prompt which tree was active when the last command finished, how many patches are applied locally and if there are uncommitted changes (including files not tracked by version control).

• In your home directory, open the file called .bashrc.
• Find this line

  unset color_prompt force_color_prompt

• After that add the following code:

hg_info() {
    declare tipRevision=`hg log -r . -T {node} 2> /dev/null`
    if [ "$tipRevision" == '' ];then
        echo ''
        return
    fi
    declare fxheads=`hg fxheads -T '{label("log.changeset", node)} {label("log.tag", join(fxheads, "+"))}\n' 2> /dev/null`
    declare shortestDistance=-2 # Not found
    declare shortestDistanceTrees=''
    while read -r line; do
        IFS=', ' read -r -a array <<< "$line"
        declare headRevision=${array[0]}
        declare headTrees=${array[1]}
        declare distance=`hg log -r $headRevision::. --template x | wc -c`
        declare distance=$((distance-1))
        if [ "$distance" -gt -1 ];then
            if [ "$shortestDistance" -eq -2 ];then
                declare shortestDistance=$distance
                declare shortestDistanceTrees=$headTrees
            elif [ "$distance" -lt "$shortestDistance" ];then
                    declare shortestDistance=$distance
                    declare shortestDistanceTrees=$headTrees
            fi
        fi
    done <<< "$fxheads"
    # echo "shortest distance for $shortestDistanceTrees with distance $shortestDistance"
    declare bash_string=''
    if [ "$shortestDistanceTrees" == '' ];then
        declare bash_string=' (?'
    else
        declare bash_string=' '$shortestDistanceTrees
        if [ "$shortestDistance" -eq 0 ];then
            declare bash_string=$bash_string'(0'
        else
            declare bash_string=$bash_string'(+'$shortestDistance''
        fi
    fi
    declare uncommitChanges=`hg status`
    if [ "$uncommitChanges" == '' ];then
        declare bash_string=$bash_string')'
    else
        declare bash_string=$bash_string'+changes)'
    fi
    echo "$bash_string"
}

export PS1="\u@\h \[\033[32m\]\w\[\033[33m\]\$(hg_info)\[\033[00m\] $ "

• Save and close the file.

New console windows will show the active tree, the number of patches applied locally and untracked changes including files not tracked by version control (e.g. .rej files from a conflict).

Example:

user@VirtualBox ~/mozilla/mozilla-unified beta(+2+changes) $

The active repository is beta, there are 2 local commits and untracked changes (more information about those with hg status).

If you pulled new changes from the server but didn't update the active repository to those, the script will try to find a different tree for which the working directory has all the changesets and e.g. show a big number of changesets for the tree due to that (e.g. central(+67)) or a question mark if it finds no tree fulfilling that condition ((?)).